biglake

package
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: Dec 7, 2023 License: BSD-3-Clause Imports: 16 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 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/{cata
	// log_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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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/{cata
	// log_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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Database: Database is the container of tables.

func (*Database) MarshalJSON

func (s *Database) 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListTablesResponse: Response message for the ListTables method.

func (*ListTablesResponse) MarshalJSON

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

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsCreateCall) Do

Do executes the "biglake.projects.locations.catalogs.create" call. Exactly one of *Catalog or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

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. Exactly one of *Database or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDatabasesCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsDatabasesDeleteCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.delete" call. Exactly one of *Database or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDatabasesDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsDatabasesGetCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.get" call. Exactly one of *Database or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDatabasesGetCall) Header

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

func (*ProjectsLocationsCatalogsDatabasesGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsDatabasesListCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.list" call. Exactly one of *ListDatabasesResponse or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDatabasesListCall) Header

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

func (*ProjectsLocationsCatalogsDatabasesListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsDatabasesPatchCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.patch" call. Exactly one of *Database or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDatabasesPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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/{ca talog_id}.

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/{ca talog_id}/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/{ca talog_id}/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/{ca talog_id}.

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/{ca talog_id}/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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsDatabasesTablesCreateCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.create" call. Exactly one of *Table or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDatabasesTablesCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsDatabasesTablesDeleteCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.delete" call. Exactly one of *Table or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDatabasesTablesDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsDatabasesTablesGetCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.get" call. Exactly one of *Table or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDatabasesTablesGetCall) Header

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

func (*ProjectsLocationsCatalogsDatabasesTablesGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.list" call. Exactly one of *ListTablesResponse or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) Header

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

func (*ProjectsLocationsCatalogsDatabasesTablesListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsDatabasesTablesPatchCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.patch" call. Exactly one of *Table or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDatabasesTablesPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsDatabasesTablesRenameCall) Do

Do executes the "biglake.projects.locations.catalogs.databases.tables.rename" call. Exactly one of *Table or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDatabasesTablesRenameCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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/{ca talog_id}/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/{ca talog_id}/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/{ca talog_id}/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/{ca talog_id}/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/{ca talog_id}/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/{ca talog_id}/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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsDeleteCall) Do

Do executes the "biglake.projects.locations.catalogs.delete" call. Exactly one of *Catalog or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsGetCall) Do

Do executes the "biglake.projects.locations.catalogs.get" call. Exactly one of *Catalog or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsGetCall) Header

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

func (*ProjectsLocationsCatalogsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsCatalogsListCall) Do

Do executes the "biglake.projects.locations.catalogs.list" call. Exactly one of *ListCatalogsResponse or error will be non-nil. 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 information.

func (*ProjectsLocationsCatalogsListCall) Header

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

func (*ProjectsLocationsCatalogsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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/{ca talog_id}.

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/{ca talog_id}.

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 {
	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/{cata
	// log_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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	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 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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/{cata
	// log_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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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