Class MetastorePartitionServiceClient (2.26.0)

MetastorePartitionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigquery_storage_v1alpha.services.metastore_partition_service.transports.base.MetastorePartitionServiceTransport, typing.Callable[[...], google.cloud.bigquery_storage_v1alpha.services.metastore_partition_service.transports.base.MetastorePartitionServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

BigQuery Metastore Partition Service API. This service is used for managing metastore partitions in BigQuery metastore. The service supports only batch operations for write.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type	Description
`str`	The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type	Description
`MetastorePartitionServiceTransport`	The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type	Description
`str`	The universe domain used by the client instance.

Methods

MetastorePartitionServiceClient

MetastorePartitionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigquery_storage_v1alpha.services.metastore_partition_service.transports.base.MetastorePartitionServiceTransport, typing.Callable[[...], google.cloud.bigquery_storage_v1alpha.services.metastore_partition_service.transports.base.MetastorePartitionServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the metastore partition service client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Optional[Union[str,MetastorePartitionServiceTransport,Callable[..., MetastorePartitionServiceTransport]]]` The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the MetastorePartitionServiceTransport constructor. If set to None, a transport is chosen automatically.
`client_options`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. 1. The `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that the `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

batch_create_metastore_partitions

batch_create_metastore_partitions(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_storage_v1alpha.types.metastore_partition.BatchCreateMetastorePartitionsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.bigquery_storage_v1alpha.types.metastore_partition.BatchCreateMetastorePartitionsResponse
)

Adds metastore partitions to a table.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_storage_v1alpha

def sample_batch_create_metastore_partitions():
    # Create a client
    client = bigquery_storage_v1alpha.MetastorePartitionServiceClient()

    # Initialize request argument(s)
    requests = bigquery_storage_v1alpha.CreateMetastorePartitionRequest()
    requests.parent = "parent_value"
    requests.metastore_partition.values = ['values_value1', 'values_value2']

    request = bigquery_storage_v1alpha.BatchCreateMetastorePartitionsRequest(
        parent="parent_value",
        requests=requests,
    )

    # Make the request
    response = client.batch_create_metastore_partitions(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.bigquery_storage_v1alpha.types.BatchCreateMetastorePartitionsRequest, dict]` The request object. Request message for BatchCreateMetastorePartitions.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.bigquery_storage_v1alpha.types.BatchCreateMetastorePartitionsResponse`	Response message for BatchCreateMetastorePartitions.

batch_delete_metastore_partitions

batch_delete_metastore_partitions(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_storage_v1alpha.types.metastore_partition.BatchDeleteMetastorePartitionsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes metastore partitions from a table.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_storage_v1alpha

def sample_batch_delete_metastore_partitions():
    # Create a client
    client = bigquery_storage_v1alpha.MetastorePartitionServiceClient()

    # Initialize request argument(s)
    partition_values = bigquery_storage_v1alpha.MetastorePartitionValues()
    partition_values.values = ['values_value1', 'values_value2']

    request = bigquery_storage_v1alpha.BatchDeleteMetastorePartitionsRequest(
        parent="parent_value",
        partition_values=partition_values,
    )

    # Make the request
    client.batch_delete_metastore_partitions(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.bigquery_storage_v1alpha.types.BatchDeleteMetastorePartitionsRequest, dict]` The request object. Request message for BatchDeleteMetastorePartitions. The MetastorePartition is uniquely identified by values, which is an ordered list. Hence, there is no separate name or partition id field.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

batch_update_metastore_partitions

batch_update_metastore_partitions(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_storage_v1alpha.types.metastore_partition.BatchUpdateMetastorePartitionsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.bigquery_storage_v1alpha.types.metastore_partition.BatchUpdateMetastorePartitionsResponse
)

Updates metastore partitions in a table.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_storage_v1alpha

def sample_batch_update_metastore_partitions():
    # Create a client
    client = bigquery_storage_v1alpha.MetastorePartitionServiceClient()

    # Initialize request argument(s)
    requests = bigquery_storage_v1alpha.UpdateMetastorePartitionRequest()
    requests.metastore_partition.values = ['values_value1', 'values_value2']

    request = bigquery_storage_v1alpha.BatchUpdateMetastorePartitionsRequest(
        parent="parent_value",
        requests=requests,
    )

    # Make the request
    response = client.batch_update_metastore_partitions(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.bigquery_storage_v1alpha.types.BatchUpdateMetastorePartitionsRequest, dict]` The request object. Request message for BatchUpdateMetastorePartitions.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.bigquery_storage_v1alpha.types.BatchUpdateMetastorePartitionsResponse`	Response message for BatchUpdateMetastorePartitions.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`MetastorePartitionServiceClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`MetastorePartitionServiceClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`MetastorePartitionServiceClient`	The constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

list_metastore_partitions

list_metastore_partitions(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_storage_v1alpha.types.metastore_partition.ListMetastorePartitionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.bigquery_storage_v1alpha.types.metastore_partition.ListMetastorePartitionsResponse
)

Gets metastore partitions from a table.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_storage_v1alpha

def sample_list_metastore_partitions():
    # Create a client
    client = bigquery_storage_v1alpha.MetastorePartitionServiceClient()

    # Initialize request argument(s)
    request = bigquery_storage_v1alpha.ListMetastorePartitionsRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.list_metastore_partitions(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.bigquery_storage_v1alpha.types.ListMetastorePartitionsRequest, dict]` The request object. Request message for ListMetastorePartitions.
`parent`	`str` Required. Reference to the table to which these metastore partitions belong, in the format of projects/{project}/locations/{location}/datasets/{dataset}/tables/{table}. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.bigquery_storage_v1alpha.types.ListMetastorePartitionsResponse`	Response message for ListMetastorePartitions.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_read_stream_path

parse_read_stream_path(path: str) -> typing.Dict[str, str]

Parses a read_stream path into its component segments.

parse_table_path

parse_table_path(path: str) -> typing.Dict[str, str]

Parses a table path into its component segments.

read_stream_path

read_stream_path(project: str, location: str, session: str, stream: str) -> str

Returns a fully-qualified read_stream string.

stream_metastore_partitions

stream_metastore_partitions(
    requests: typing.Optional[
        typing.Iterator[
            google.cloud.bigquery_storage_v1alpha.types.metastore_partition.StreamMetastorePartitionsRequest
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
    google.cloud.bigquery_storage_v1alpha.types.metastore_partition.StreamMetastorePartitionsResponse
]

This is a bi-di streaming rpc method that allows the client to send a stream of partitions and commit all of them atomically at the end. If the commit is successful, the server will return a response and close the stream. If the commit fails (due to duplicate partitions or other reason), the server will close the stream with an error. This method is only available via the gRPC API (not REST).

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_storage_v1alpha

def sample_stream_metastore_partitions():
    # Create a client
    client = bigquery_storage_v1alpha.MetastorePartitionServiceClient()

    # Initialize request argument(s)
    request = bigquery_storage_v1alpha.StreamMetastorePartitionsRequest(
        parent="parent_value",
    )

    # This method expects an iterator which contains
    # 'bigquery_storage_v1alpha.StreamMetastorePartitionsRequest' objects
    # Here we create a generator that yields a single `request` for
    # demonstrative purposes.
    requests = [request]

    def request_generator():
        for request in requests:
            yield request

    # Make the request
    stream = client.stream_metastore_partitions(requests=request_generator())

    # Handle the response
    for response in stream:
        print(response)

Parameters
Name	Description
`requests`	`Iterator[google.cloud.bigquery_storage_v1alpha.types.StreamMetastorePartitionsRequest]` The request object iterator. The top-level message sent by the client to the [Partitions.StreamMetastorePartitions][] method. Follows the default gRPC streaming maximum size of 4 MB.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`Iterable[google.cloud.bigquery_storage_v1alpha.types.StreamMetastorePartitionsResponse]`	This is the response message sent by the server to the client for the [Partitions.StreamMetastorePartitions][] method when the commit is successful. Server will close the stream after sending this message.

table_path

table_path(project: str, dataset: str, table: str) -> str

Returns a fully-qualified table string.