biglake

package
v0.255.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 4, 2025 License: BSD-3-Clause Imports: 18 Imported by: 0

Documentation

Overview

Package biglake provides access to the BigLake API.

For product documentation, see: https://cloud.google.com/bigquery/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/biglake/v1"
...
ctx := context.Background()
biglakeService, err := biglake.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:

biglakeService, err := biglake.NewService(ctx, option.WithScopes(biglake.CloudPlatformScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

biglakeService, err := biglake.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
biglakeService, err := biglake.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// View and manage your data in Google BigQuery and see the email address for
	// your Google Account
	BigqueryScope = "https://www.googleapis.com/auth/bigquery"

	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuditConfig added in v0.255.0

type AuditConfig struct {
	// AuditLogConfigs: The configuration for logging of each type of permission.
	AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
	// Service: Specifies a service that will be enabled for audit logging. For
	// example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices`
	// is a special value that covers all services.
	Service string `json:"service,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuditLogConfigs") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AuditConfig: Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.

func (AuditConfig) MarshalJSON added in v0.255.0

func (s AuditConfig) MarshalJSON() ([]byte, error)

type AuditLogConfig added in v0.255.0

type AuditLogConfig struct {
	// ExemptedMembers: Specifies the identities that do not cause logging for this
	// type of permission. Follows the same format of Binding.members.
	ExemptedMembers []string `json:"exemptedMembers,omitempty"`
	// LogType: The log type that this config enables.
	//
	// Possible values:
	//   "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
	//   "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
	//   "DATA_WRITE" - Data writes. Example: CloudSQL Users create
	//   "DATA_READ" - Data reads. Example: CloudSQL Users list
	LogType string `json:"logType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExemptedMembers") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AuditLogConfig: Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

func (AuditLogConfig) MarshalJSON added in v0.255.0

func (s AuditLogConfig) MarshalJSON() ([]byte, error)

type Binding added in v0.255.0

type Binding struct {
	// Condition: The condition that is associated with this binding. If the
	// condition evaluates to `true`, then this binding applies to the current
	// request. If the condition evaluates to `false`, then this binding does not
	// apply to the current request. However, a different role binding might grant
	// the same role to one or more of the principals in this binding. To learn
	// which resources support conditions in their IAM policies, see the IAM
	// documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition *Expr `json:"condition,omitempty"`
	// Members: Specifies the principals requesting access for a Google Cloud
	// resource. `members` can have the following values: * `allUsers`: A special
	// identifier that represents anyone who is on the internet; with or without a
	// Google account. * `allAuthenticatedUsers`: A special identifier that
	// represents anyone who is authenticated with a Google account or a service
	// account. Does not include identities that come from external identity
	// providers (IdPs) through identity federation. * `user:{emailid}`: An email
	// address that represents a specific Google account. For example,
	// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
	// represents a Google service account. For example,
	// `my-other-app@appspot.gserviceaccount.com`. *
	// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
	// identifier for a Kubernetes service account
	// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
	// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
	// `group:{emailid}`: An email address that represents a Google group. For
	// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
	// (primary) that represents all the users of that domain. For example,
	// `google.com` or `example.com`. *
	// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub
	// ject/{subject_attribute_value}`: A single identity in a workforce identity
	// pool. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// group/{group_id}`: All workforce identities in a group. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// attribute.{attribute_name}/{attribute_value}`: All workforce identities with
	// a specific attribute value. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// *`: All identities in a workforce identity pool. *
	// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo
	// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single
	// identity in a workload identity pool. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool
	// group. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}
	// `: All identities in a workload identity pool with a certain attribute. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity
	// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a user that has been recently deleted. For
	// example, `alice@example.com?uid=123456789012345678901`. If the user is
	// recovered, this value reverts to `user:{emailid}` and the recovered user
	// retains the role in the binding. *
	// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a service account that has been recently
	// deleted. For example,
	// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the
	// service account is undeleted, this value reverts to
	// `serviceAccount:{emailid}` and the undeleted service account retains the
	// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email
	// address (plus unique identifier) representing a Google group that has been
	// recently deleted. For example,
	// `admins@example.com?uid=123456789012345678901`. If the group is recovered,
	// this value reverts to `group:{emailid}` and the recovered group retains the
	// role in the binding. *
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool
	// _id}/subject/{subject_attribute_value}`: Deleted single identity in a
	// workforce identity pool. For example,
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po
	// ol-id/subject/my-subject-attribute-value`.
	Members []string `json:"members,omitempty"`
	// Role: Role that is assigned to the list of `members`, or principals. For
	// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview
	// of the IAM roles and permissions, see the IAM documentation
	// (https://cloud.google.com/iam/docs/roles-overview). For a list of the
	// available pre-defined roles, see here
	// (https://cloud.google.com/iam/docs/understanding-roles).
	Role string `json:"role,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Condition") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Condition") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Binding: Associates `members`, or principals, with a `role`.

func (Binding) MarshalJSON added in v0.255.0

func (s Binding) MarshalJSON() ([]byte, error)

type Catalog

type Catalog struct {
	// CreateTime: Output only. The creation time of the catalog.
	CreateTime string `json:"createTime,omitempty"`
	// DeleteTime: Output only. The deletion time of the catalog. Only set after
	// the catalog is deleted.
	DeleteTime string `json:"deleteTime,omitempty"`
	// ExpireTime: Output only. The time when this catalog is considered expired.
	// Only set after the catalog is deleted.
	ExpireTime string `json:"expireTime,omitempty"`
	// Name: Output only. The resource name. Format:
	// projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
	Name string `json:"name,omitempty"`
	// UpdateTime: Output only. The last modification time of the catalog.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Catalog: Catalog is the container of databases.

func (Catalog) MarshalJSON

func (s Catalog) MarshalJSON() ([]byte, error)

type Database

type Database struct {
	// CreateTime: Output only. The creation time of the database.
	CreateTime string `json:"createTime,omitempty"`
	// DeleteTime: Output only. The deletion time of the database. Only set after
	// the database is deleted.
	DeleteTime string `json:"deleteTime,omitempty"`
	// ExpireTime: Output only. The time when this database is considered expired.
	// Only set after the database is deleted.
	ExpireTime string `json:"expireTime,omitempty"`
	// HiveOptions: Options of a Hive database.
	HiveOptions *HiveDatabaseOptions `json:"hiveOptions,omitempty"`
	// Name: Output only. The resource name. Format:
	// projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
	// /databases/{database_id}
	Name string `json:"name,omitempty"`
	// Type: The database type.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - The type is not specified.
	//   "HIVE" - Represents a database storing tables compatible with Hive
	// Metastore tables.
	Type string `json:"type,omitempty"`
	// UpdateTime: Output only. The last modification time of the database.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Database: Database is the container of tables.

func (Database) MarshalJSON

func (s Database) MarshalJSON() ([]byte, error)

type Expr added in v0.255.0

type Expr struct {
	// Description: Optional. Description of the expression. This is a longer text
	// which describes the expression, e.g. when hovered over it in a UI.
	Description string `json:"description,omitempty"`
	// Expression: Textual representation of an expression in Common Expression
	// Language syntax.
	Expression string `json:"expression,omitempty"`
	// Location: Optional. String indicating the location of the expression for
	// error reporting, e.g. a file name and a position in the file.
	Location string `json:"location,omitempty"`
	// Title: Optional. Title for the expression, i.e. a short string describing
	// its purpose. This can be used e.g. in UIs which allow to enter the
	// expression.
	Title string `json:"title,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Expr: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (Expr) MarshalJSON added in v0.255.0

func (s Expr) MarshalJSON() ([]byte, error)

type HiveDatabaseOptions

type HiveDatabaseOptions struct {
	// LocationUri: Cloud Storage folder URI where the database data is stored,
	// starting with "gs://".
	LocationUri string `json:"locationUri,omitempty"`
	// Parameters: Stores user supplied Hive database parameters.
	Parameters map[string]string `json:"parameters,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LocationUri") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LocationUri") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

HiveDatabaseOptions: Options of a Hive database.

func (HiveDatabaseOptions) MarshalJSON

func (s HiveDatabaseOptions) MarshalJSON() ([]byte, error)

type HiveTableOptions

type HiveTableOptions struct {
	// Parameters: Stores user supplied Hive table parameters.
	Parameters map[string]string `json:"parameters,omitempty"`
	// StorageDescriptor: Stores physical storage information of the data.
	StorageDescriptor *StorageDescriptor `json:"storageDescriptor,omitempty"`
	// TableType: Hive table type. For example, MANAGED_TABLE, EXTERNAL_TABLE.
	TableType string `json:"tableType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Parameters") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Parameters") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

HiveTableOptions: Options of a Hive table.

func (HiveTableOptions) MarshalJSON

func (s HiveTableOptions) MarshalJSON() ([]byte, error)

type ListCatalogsResponse

type ListCatalogsResponse struct {
	// Catalogs: The catalogs from the specified project.
	Catalogs []*Catalog `json:"catalogs,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Catalogs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Catalogs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListCatalogsResponse: Response message for the ListCatalogs method.

func (ListCatalogsResponse) MarshalJSON

func (s ListCatalogsResponse) MarshalJSON() ([]byte, error)

type ListDatabasesResponse

type ListDatabasesResponse struct {
	// Databases: The databases from the specified catalog.
	Databases []*Database `json:"databases,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Databases") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Databases") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListDatabasesResponse: Response message for the ListDatabases method.

func (ListDatabasesResponse) MarshalJSON

func (s ListDatabasesResponse) MarshalJSON() ([]byte, error)

type ListTablesResponse

type ListTablesResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Tables: The tables from the specified database.
	Tables []*Table `json:"tables,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListTablesResponse: Response message for the ListTables method.

func (ListTablesResponse) MarshalJSON

func (s ListTablesResponse) MarshalJSON() ([]byte, error)

type Policy added in v0.255.0

type Policy struct {
	// AuditConfigs: Specifies cloud audit logging configuration for this policy.
	AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
	// Bindings: Associates a list of `members`, or principals, with a `role`.
	// Optionally, may specify a `condition` that determines how and when the
	// `bindings` are applied. Each of the `bindings` must contain at least one
	// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;
	// up to 250 of these principals can be Google groups. Each occurrence of a
	// principal counts towards these limits. For example, if the `bindings` grant
	// 50 different roles to `user:alice@example.com`, and not to any other
	// principal, then you can add another 1,450 principals to the `bindings` in
	// the `Policy`.
	Bindings []*Binding `json:"bindings,omitempty"`
	// Etag: `etag` is used for optimistic concurrency control as a way to help
	// prevent simultaneous updates of a policy from overwriting each other. It is
	// strongly suggested that systems make use of the `etag` in the
	// read-modify-write cycle to perform policy updates in order to avoid race
	// conditions: An `etag` is returned in the response to `getIamPolicy`, and
	// systems are expected to put that etag in the request to `setIamPolicy` to
	// ensure that their change will be applied to the same version of the policy.
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost.
	Etag string `json:"etag,omitempty"`
	// Version: Specifies the format of the policy. Valid values are `0`, `1`, and
	// `3`. Requests that specify an invalid value are rejected. Any operation that
	// affects conditional role bindings must specify version `3`. This requirement
	// applies to the following operations: * Getting a policy that includes a
	// conditional role binding * Adding a conditional role binding to a policy *
	// Changing a conditional role binding in a policy * Removing any role binding,
	// with or without a condition, from a policy that includes conditions
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost. If a policy does not
	// include any conditions, operations on that policy may specify any valid
	// version or leave the field unset. To learn which resources support
	// conditions in their IAM policies, see the IAM documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Version int64 `json:"version,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AuditConfigs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuditConfigs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

func (Policy) MarshalJSON added in v0.255.0

func (s Policy) MarshalJSON() ([]byte, error)

type ProjectsCatalogsGetIamPolicyCall added in v0.255.0

type ProjectsCatalogsGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsCatalogsGetIamPolicyCall) Context added in v0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsCatalogsGetIamPolicyCall) Do added in v0.255.0

Do executes the "biglake.projects.catalogs.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsCatalogsGetIamPolicyCall) Fields added in v0.255.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsCatalogsGetIamPolicyCall) Header added in v0.255.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsCatalogsGetIamPolicyCall) IfNoneMatch added in v0.255.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsCatalogsGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.255.0

func (c *ProjectsCatalogsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsCatalogsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsCatalogsNamespacesGetIamPolicyCall added in v0.255.0

type ProjectsCatalogsNamespacesGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsCatalogsNamespacesGetIamPolicyCall) Context added in v0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsCatalogsNamespacesGetIamPolicyCall) Do added in v0.255.0

Do executes the "biglake.projects.catalogs.namespaces.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsCatalogsNamespacesGetIamPolicyCall) Fields added in v0.255.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsCatalogsNamespacesGetIamPolicyCall) Header added in v0.255.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsCatalogsNamespacesGetIamPolicyCall) IfNoneMatch added in v0.255.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsCatalogsNamespacesGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.255.0

func (c *ProjectsCatalogsNamespacesGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsCatalogsNamespacesGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsCatalogsNamespacesService added in v0.255.0

type ProjectsCatalogsNamespacesService struct {
	// contains filtered or unexported fields
}

func NewProjectsCatalogsNamespacesService added in v0.255.0

func NewProjectsCatalogsNamespacesService(s *Service) *ProjectsCatalogsNamespacesService

func (*ProjectsCatalogsNamespacesService) GetIamPolicy added in v0.255.0

GetIamPolicy: Gets the IAM policy for the specified Catalog.

func (*ProjectsCatalogsNamespacesService) SetIamPolicy added in v0.255.0

SetIamPolicy: Sets the IAM policy for the specified catalog.

type ProjectsCatalogsNamespacesSetIamPolicyCall added in v0.255.0

type ProjectsCatalogsNamespacesSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsCatalogsNamespacesSetIamPolicyCall) Context added in v0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsCatalogsNamespacesSetIamPolicyCall) Do added in v0.255.0

Do executes the "biglake.projects.catalogs.namespaces.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsCatalogsNamespacesSetIamPolicyCall) Fields added in v0.255.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsCatalogsNamespacesSetIamPolicyCall) Header added in v0.255.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsCatalogsService added in v0.255.0

type ProjectsCatalogsService struct {
	Namespaces *ProjectsCatalogsNamespacesService
	// contains filtered or unexported fields
}

func NewProjectsCatalogsService added in v0.255.0

func NewProjectsCatalogsService(s *Service) *ProjectsCatalogsService

func (*ProjectsCatalogsService) GetIamPolicy added in v0.255.0

GetIamPolicy: Gets the IAM policy for the specified Catalog.

func (*ProjectsCatalogsService) SetIamPolicy added in v0.255.0

func (r *ProjectsCatalogsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsCatalogsSetIamPolicyCall

SetIamPolicy: Sets the IAM policy for the specified catalog.

type ProjectsCatalogsSetIamPolicyCall added in v0.255.0

type ProjectsCatalogsSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsCatalogsSetIamPolicyCall) Context added in v0.255.0

Context sets the context to be used in this call's Do method.

func (*ProjectsCatalogsSetIamPolicyCall) Do added in v0.255.0

Do executes the "biglake.projects.catalogs.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsCatalogsSetIamPolicyCall) Fields added in v0.255.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsCatalogsSetIamPolicyCall) Header added in v0.255.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsCatalogsCreateCall

type ProjectsLocationsCatalogsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsCreateCall) CatalogId

CatalogId sets the optional parameter "catalogId": Required. The ID to use for the catalog, which will become the final component of the catalog's resource name.

func (*ProjectsLocationsCatalogsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsCreateCall) Do

Do executes the "biglake.projects.locations.catalogs.create" call. Any non-2xx status code is an error. Response headers are in either *Catalog.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsCatalogsDatabasesCreateCall

type ProjectsLocationsCatalogsDatabasesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDatabasesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDatabasesCreateCall) DatabaseId

DatabaseId sets the optional parameter "databaseId": Required. The ID to use for the database, which will become the final component of the database's resource name.

func (*ProjectsLocationsCatalogsDatabasesCreateCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.create" call. Any non-2xx status code is an error. Response headers are in either *Database.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDatabasesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDatabasesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsCatalogsDatabasesDeleteCall

type ProjectsLocationsCatalogsDatabasesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDatabasesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDatabasesDeleteCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.delete" call. Any non-2xx status code is an error. Response headers are in either *Database.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDatabasesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDatabasesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsCatalogsDatabasesGetCall

type ProjectsLocationsCatalogsDatabasesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDatabasesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDatabasesGetCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.get" call. Any non-2xx status code is an error. Response headers are in either *Database.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDatabasesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDatabasesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsCatalogsDatabasesGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsCatalogsDatabasesListCall

type ProjectsLocationsCatalogsDatabasesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDatabasesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDatabasesListCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.list" call. Any non-2xx status code is an error. Response headers are in either *ListDatabasesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDatabasesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDatabasesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsCatalogsDatabasesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsCatalogsDatabasesListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 50 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*ProjectsLocationsCatalogsDatabasesListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabases` must match the call that provided the page token.

func (*ProjectsLocationsCatalogsDatabasesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsCatalogsDatabasesPatchCall

type ProjectsLocationsCatalogsDatabasesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDatabasesPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDatabasesPatchCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.patch" call. Any non-2xx status code is an error. Response headers are in either *Database.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDatabasesPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDatabasesPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsCatalogsDatabasesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": The list of fields to update. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.

type ProjectsLocationsCatalogsDatabasesService

type ProjectsLocationsCatalogsDatabasesService struct {
	Tables *ProjectsLocationsCatalogsDatabasesTablesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsCatalogsDatabasesService

func NewProjectsLocationsCatalogsDatabasesService(s *Service) *ProjectsLocationsCatalogsDatabasesService

func (*ProjectsLocationsCatalogsDatabasesService) Create

Create: Creates a new database.

  • parent: The parent resource where this database will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}.

func (*ProjectsLocationsCatalogsDatabasesService) Delete

Delete: Deletes an existing database specified by the database ID.

  • name: The name of the database to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}/databases/{database_id}.

func (*ProjectsLocationsCatalogsDatabasesService) Get

Get: Gets the database specified by the resource name.

  • name: The name of the database to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}/databases/{database_id}.

func (*ProjectsLocationsCatalogsDatabasesService) List

List: List all databases in a specified catalog.

  • parent: The parent, which owns this collection of databases. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}.

func (*ProjectsLocationsCatalogsDatabasesService) Patch

Patch: Updates an existing database specified by the database ID.

  • name: Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}/databases/{database_id}.

type ProjectsLocationsCatalogsDatabasesTablesCreateCall

type ProjectsLocationsCatalogsDatabasesTablesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDatabasesTablesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDatabasesTablesCreateCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.create" call. Any non-2xx status code is an error. Response headers are in either *Table.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDatabasesTablesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDatabasesTablesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsCatalogsDatabasesTablesCreateCall) TableId

TableId sets the optional parameter "tableId": Required. The ID to use for the table, which will become the final component of the table's resource name.

type ProjectsLocationsCatalogsDatabasesTablesDeleteCall

type ProjectsLocationsCatalogsDatabasesTablesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDatabasesTablesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDatabasesTablesDeleteCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.delete" call. Any non-2xx status code is an error. Response headers are in either *Table.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDatabasesTablesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDatabasesTablesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsCatalogsDatabasesTablesGetCall

type ProjectsLocationsCatalogsDatabasesTablesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDatabasesTablesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDatabasesTablesGetCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.get" call. Any non-2xx status code is an error. Response headers are in either *Table.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDatabasesTablesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDatabasesTablesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsCatalogsDatabasesTablesGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsCatalogsDatabasesTablesListCall

type ProjectsLocationsCatalogsDatabasesTablesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.list" call. Any non-2xx status code is an error. Response headers are in either *ListTablesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 50 tables will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListTables` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTables` must match the call that provided the page token.

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) View

View sets the optional parameter "view": The view for the returned tables.

Possible values:

"TABLE_VIEW_UNSPECIFIED" - Default value. The API will default to the

BASIC view.

"BASIC" - Include only table names. This is the default value.
"FULL" - Include everything.

type ProjectsLocationsCatalogsDatabasesTablesPatchCall

type ProjectsLocationsCatalogsDatabasesTablesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDatabasesTablesPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDatabasesTablesPatchCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.patch" call. Any non-2xx status code is an error. Response headers are in either *Table.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDatabasesTablesPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDatabasesTablesPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsCatalogsDatabasesTablesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": The list of fields to update. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.

type ProjectsLocationsCatalogsDatabasesTablesRenameCall

type ProjectsLocationsCatalogsDatabasesTablesRenameCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDatabasesTablesRenameCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDatabasesTablesRenameCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.rename" call. Any non-2xx status code is an error. Response headers are in either *Table.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDatabasesTablesRenameCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDatabasesTablesRenameCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsCatalogsDatabasesTablesService

type ProjectsLocationsCatalogsDatabasesTablesService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsCatalogsDatabasesTablesService

func NewProjectsLocationsCatalogsDatabasesTablesService(s *Service) *ProjectsLocationsCatalogsDatabasesTablesService

func (*ProjectsLocationsCatalogsDatabasesTablesService) Create

Create: Creates a new table.

  • parent: The parent resource where this table will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}/databases/{database_id}.

func (*ProjectsLocationsCatalogsDatabasesTablesService) Delete

Delete: Deletes an existing table specified by the table ID.

  • name: The name of the table to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}/databases/{database_id}/tables/{table_id}.

func (*ProjectsLocationsCatalogsDatabasesTablesService) Get

Get: Gets the table specified by the resource name.

  • name: The name of the table to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}/databases/{database_id}/tables/{table_id}.

func (*ProjectsLocationsCatalogsDatabasesTablesService) List

List: List all tables in a specified database.

  • parent: The parent, which owns this collection of tables. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}/databases/{database_id}.

func (*ProjectsLocationsCatalogsDatabasesTablesService) Patch

Patch: Updates an existing table specified by the table ID.

  • name: Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}/databases/{database_id}/tables/{table_id}.

func (*ProjectsLocationsCatalogsDatabasesTablesService) Rename

Rename: Renames an existing table specified by the table ID.

  • name: The table's `name` field is used to identify the table to rename. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}/databases/{database_id}/tables/{table_id}.

type ProjectsLocationsCatalogsDeleteCall

type ProjectsLocationsCatalogsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsDeleteCall) Do

Do executes the "biglake.projects.locations.catalogs.delete" call. Any non-2xx status code is an error. Response headers are in either *Catalog.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsCatalogsGetCall

type ProjectsLocationsCatalogsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsGetCall) Do

Do executes the "biglake.projects.locations.catalogs.get" call. Any non-2xx status code is an error. Response headers are in either *Catalog.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsCatalogsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsCatalogsListCall

type ProjectsLocationsCatalogsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCatalogsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsListCall) Do

Do executes the "biglake.projects.locations.catalogs.list" call. Any non-2xx status code is an error. Response headers are in either *ListCatalogsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsCatalogsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsCatalogsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsCatalogsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of catalogs to return. The service may return fewer than this value. If unspecified, at most 50 catalogs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*ProjectsLocationsCatalogsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCatalogs` must match the call that provided the page token.

func (*ProjectsLocationsCatalogsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsCatalogsService

type ProjectsLocationsCatalogsService struct {
	Databases *ProjectsLocationsCatalogsDatabasesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsCatalogsService

func NewProjectsLocationsCatalogsService(s *Service) *ProjectsLocationsCatalogsService

func (*ProjectsLocationsCatalogsService) Create

Create: Creates a new catalog.

  • parent: The parent resource where this catalog will be created. Format: projects/{project_id_or_number}/locations/{location_id}.

func (*ProjectsLocationsCatalogsService) Delete

Delete: Deletes an existing catalog specified by the catalog ID.

  • name: The name of the catalog to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}.

func (*ProjectsLocationsCatalogsService) Get

Get: Gets the catalog specified by the resource name.

  • name: The name of the catalog to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_i d}.

func (*ProjectsLocationsCatalogsService) List

List: List all catalogs in a specified project.

  • parent: The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number}/locations/{location_id}.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	Catalogs *ProjectsLocationsCatalogsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

type ProjectsService

type ProjectsService struct {
	Catalogs *ProjectsCatalogsService

	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type RenameTableRequest

type RenameTableRequest struct {
	// NewName: Required. The new `name` for the specified table, must be in the
	// same database. Format:
	// projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
	// /databases/{database_id}/tables/{table_id}
	NewName string `json:"newName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "NewName") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NewName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RenameTableRequest: Request message for the RenameTable method in MetastoreService

func (RenameTableRequest) MarshalJSON

func (s RenameTableRequest) MarshalJSON() ([]byte, error)

type SerDeInfo

type SerDeInfo struct {
	// SerializationLib: The fully qualified Java class name of the serialization
	// library.
	SerializationLib string `json:"serializationLib,omitempty"`
	// ForceSendFields is a list of field names (e.g. "SerializationLib") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "SerializationLib") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SerDeInfo: Serializer and deserializer information.

func (SerDeInfo) MarshalJSON

func (s SerDeInfo) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SetIamPolicyRequest added in v0.255.0

type SetIamPolicyRequest struct {
	// Policy: REQUIRED: The complete policy to be applied to the `resource`. The
	// size of the policy is limited to a few 10s of KB. An empty policy is a valid
	// policy but certain Google Cloud services (such as Projects) might reject
	// them.
	Policy *Policy `json:"policy,omitempty"`
	// UpdateMask: OPTIONAL: A FieldMask specifying which fields of the policy to
	// modify. Only the fields in the mask will be modified. If no mask is
	// provided, the following default mask is used: `paths: "bindings, etag"
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Policy") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Policy") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (SetIamPolicyRequest) MarshalJSON added in v0.255.0

func (s SetIamPolicyRequest) MarshalJSON() ([]byte, error)

type StorageDescriptor

type StorageDescriptor struct {
	// InputFormat: The fully qualified Java class name of the input format.
	InputFormat string `json:"inputFormat,omitempty"`
	// LocationUri: Cloud Storage folder URI where the table data is stored,
	// starting with "gs://".
	LocationUri string `json:"locationUri,omitempty"`
	// OutputFormat: The fully qualified Java class name of the output format.
	OutputFormat string `json:"outputFormat,omitempty"`
	// SerdeInfo: Serializer and deserializer information.
	SerdeInfo *SerDeInfo `json:"serdeInfo,omitempty"`
	// ForceSendFields is a list of field names (e.g. "InputFormat") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "InputFormat") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

StorageDescriptor: Stores physical storage information of the data.

func (StorageDescriptor) MarshalJSON

func (s StorageDescriptor) MarshalJSON() ([]byte, error)

type Table

type Table struct {
	// CreateTime: Output only. The creation time of the table.
	CreateTime string `json:"createTime,omitempty"`
	// DeleteTime: Output only. The deletion time of the table. Only set after the
	// table is deleted.
	DeleteTime string `json:"deleteTime,omitempty"`
	// Etag: The checksum of a table object computed by the server based on the
	// value of other fields. It may be sent on update requests to ensure the
	// client has an up-to-date value before proceeding. It is only checked for
	// update table operations.
	Etag string `json:"etag,omitempty"`
	// ExpireTime: Output only. The time when this table is considered expired.
	// Only set after the table is deleted.
	ExpireTime string `json:"expireTime,omitempty"`
	// HiveOptions: Options of a Hive table.
	HiveOptions *HiveTableOptions `json:"hiveOptions,omitempty"`
	// Name: Output only. The resource name. Format:
	// projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
	// /databases/{database_id}/tables/{table_id}
	Name string `json:"name,omitempty"`
	// Type: The table type.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - The type is not specified.
	//   "HIVE" - Represents a table compatible with Hive Metastore tables.
	Type string `json:"type,omitempty"`
	// UpdateTime: Output only. The last modification time of the table.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Table: Represents a table.

func (Table) MarshalJSON

func (s Table) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL