MapsPlatformDatasets¶
- class google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.MapsPlatformDatasetsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.transports.base.MapsPlatformDatasetsTransport, typing.Callable[[...], google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.transports.base.MapsPlatformDatasetsTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
Service definition for the Maps Platform Datasets API.
Instantiates the maps platform datasets async client.
- Parameters
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,MapsPlatformDatasetsTransport,Callable[..., MapsPlatformDatasetsTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the MapsPlatformDatasetsTransport 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_endpointproperty can be used to override the default endpoint provided by the client whentransportis not explicitly provided. Only if this property is not set andtransportwas 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_sourceproperty 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_domainproperty can be used to override the default “googleapis.com” universe. Note thatapi_endpointproperty still takes precedence; anduniverse_domainis 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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- static common_billing_account_path(billing_account: str) str¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str¶
Returns a fully-qualified organization string.
- async create_dataset(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.CreateDatasetRequest, dict]] = None, *, parent: Optional[str] = None, dataset: Optional[google.maps.mapsplatformdatasets_v1.types.dataset.Dataset] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapsplatformdatasets_v1.types.dataset.Dataset[source]¶
Creates a new dataset for the specified project.
# 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.maps import mapsplatformdatasets_v1 async def sample_create_dataset(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsAsyncClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.CreateDatasetRequest( parent="parent_value", ) # Make the request response = await client.create_dataset(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.maps.mapsplatformdatasets_v1.types.CreateDatasetRequest, dict]]) – The request object. Request to create a maps dataset.
parent (
str) –Required. Parent project that will own the dataset. Format: projects/{project}
This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.dataset (
google.maps.mapsplatformdatasets_v1.types.Dataset) –Required. The dataset version to create.
This corresponds to the
datasetfield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
A representation of a dataset resource.
- Return type
- async delete_dataset(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.DeleteDatasetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) None[source]¶
Deletes the specified dataset.
# 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.maps import mapsplatformdatasets_v1 async def sample_delete_dataset(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsAsyncClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.DeleteDatasetRequest( name="name_value", ) # Make the request await client.delete_dataset(request=request)
- Parameters
request (Optional[Union[google.maps.mapsplatformdatasets_v1.types.DeleteDatasetRequest, dict]]) – The request object. Request to delete a dataset.
name (
str) –Required. The name of the dataset to delete. Format: projects/{project}/datasets/{dataset_id}
This corresponds to the
namefield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- async fetch_dataset_errors(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.FetchDatasetErrorsRequest, dict]] = None, *, dataset: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.pagers.FetchDatasetErrorsAsyncPager[source]¶
Gets all the errors of a dataset.
# 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.maps import mapsplatformdatasets_v1 async def sample_fetch_dataset_errors(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsAsyncClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.FetchDatasetErrorsRequest( dataset="dataset_value", ) # Make the request page_result = client.fetch_dataset_errors(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.maps.mapsplatformdatasets_v1.types.FetchDatasetErrorsRequest, dict]]) – The request object. Request to list detailed errors belonging to a dataset.
dataset (
str) –Required. The name of the dataset to list all the errors for. Format: projects/{project}/datasets/{dataset_id}
This corresponds to the
datasetfield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
Response object of FetchDatasetErrors. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- async get_dataset(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.GetDatasetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapsplatformdatasets_v1.types.dataset.Dataset[source]¶
Gets the dataset.
# 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.maps import mapsplatformdatasets_v1 async def sample_get_dataset(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsAsyncClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.GetDatasetRequest( name="name_value", ) # Make the request response = await client.get_dataset(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.maps.mapsplatformdatasets_v1.types.GetDatasetRequest, dict]]) – The request object. Request to get the specified dataset.
name (
str) –Required. Resource name. Format: projects/{project}/datasets/{dataset_id}
Can also fetch some special versions by appending “@” and a tag. Format: projects/{project}/datasets/{dataset_id}@{tag}
Tag “active”: The info of the latest completed version will be included, and NOT_FOUND if the dataset does not have one.
This corresponds to the
namefield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
A representation of a dataset resource.
- Return type
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
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.
- Parameters
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.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- classmethod get_transport_class(label: Optional[str] = None) Type[google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.transports.base.MapsPlatformDatasetsTransport]¶
Returns an appropriate transport class.
- Parameters
label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
- Returns
The transport class to use.
- async list_datasets(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.ListDatasetsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.pagers.ListDatasetsAsyncPager[source]¶
Lists all the datasets for the specified project.
# 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.maps import mapsplatformdatasets_v1 async def sample_list_datasets(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsAsyncClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.ListDatasetsRequest( parent="parent_value", ) # Make the request page_result = client.list_datasets(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.maps.mapsplatformdatasets_v1.types.ListDatasetsRequest, dict]]) – The request object. Request to list datasets for the project.
parent (
str) –Required. The name of the project to list all the datasets for. Format: projects/{project}
This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
Response object of ListDatasets.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.pagers.ListDatasetsAsyncPager
- static parse_common_billing_account_path(path: str) Dict[str, str]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str]¶
Parse a project path into its component segments.
- static parse_dataset_path(path: str) Dict[str, str]¶
Parses a dataset path into its component segments.
- property transport: google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.transports.base.MapsPlatformDatasetsTransport¶
Returns the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
MapsPlatformDatasetsTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
- The universe domain used
by the client instance.
- Return type
- async update_dataset_metadata(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.UpdateDatasetMetadataRequest, dict]] = None, *, dataset: Optional[google.maps.mapsplatformdatasets_v1.types.dataset.Dataset] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapsplatformdatasets_v1.types.dataset.Dataset[source]¶
Updates the metadata for the dataset.
# 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.maps import mapsplatformdatasets_v1 async def sample_update_dataset_metadata(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsAsyncClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.UpdateDatasetMetadataRequest( ) # Make the request response = await client.update_dataset_metadata(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.maps.mapsplatformdatasets_v1.types.UpdateDatasetMetadataRequest, dict]]) – The request object. Request to update the metadata fields of the dataset.
dataset (
google.maps.mapsplatformdatasets_v1.types.Dataset) –Required. Resource name of the dataset to update. Format: projects/{project}/datasets/{dataset_id}
This corresponds to the
datasetfield on therequestinstance; ifrequestis provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask) –The list of fields to be updated.
The value “*” is used for full replacement (default).
This corresponds to the
update_maskfield on therequestinstance; ifrequestis provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
A representation of a dataset resource.
- Return type
- class google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.MapsPlatformDatasetsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.transports.base.MapsPlatformDatasetsTransport, typing.Callable[[...], google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.transports.base.MapsPlatformDatasetsTransport]]] = 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>)[source]¶
Service definition for the Maps Platform Datasets API.
Instantiates the maps platform datasets client.
- Parameters
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,MapsPlatformDatasetsTransport,Callable[..., MapsPlatformDatasetsTransport]]]) – 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 MapsPlatformDatasetsTransport 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_endpointproperty can be used to override the default endpoint provided by the client whentransportis not explicitly provided. Only if this property is not set andtransportwas 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_sourceproperty 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_domainproperty can be used to override the default “googleapis.com” universe. Note that theapi_endpointproperty still takes precedence; anduniverse_domainis 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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- __exit__(type, value, traceback)[source]¶
Releases underlying transport’s resources.
Warning
ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- static common_billing_account_path(billing_account: str) str[source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str[source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str[source]¶
Returns a fully-qualified organization string.
- create_dataset(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.CreateDatasetRequest, dict]] = None, *, parent: Optional[str] = None, dataset: Optional[google.maps.mapsplatformdatasets_v1.types.dataset.Dataset] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapsplatformdatasets_v1.types.dataset.Dataset[source]¶
Creates a new dataset for the specified project.
# 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.maps import mapsplatformdatasets_v1 def sample_create_dataset(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.CreateDatasetRequest( parent="parent_value", ) # Make the request response = client.create_dataset(request=request) # Handle the response print(response)
- Parameters
request (Union[google.maps.mapsplatformdatasets_v1.types.CreateDatasetRequest, dict]) – The request object. Request to create a maps dataset.
parent (str) –
Required. Parent project that will own the dataset. Format: projects/{project}
This corresponds to the
parentfield on therequestinstance; ifrequestis provided, this should not be set.dataset (google.maps.mapsplatformdatasets_v1.types.Dataset) –
Required. The dataset version to create.
This corresponds to the
datasetfield on therequestinstance; ifrequestis 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, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
A representation of a dataset resource.
- Return type
- static dataset_path(project: str, dataset: str) str[source]¶
Returns a fully-qualified dataset string.
- delete_dataset(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.DeleteDatasetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) None[source]¶
Deletes the specified dataset.
# 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.maps import mapsplatformdatasets_v1 def sample_delete_dataset(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.DeleteDatasetRequest( name="name_value", ) # Make the request client.delete_dataset(request=request)
- Parameters
request (Union[google.maps.mapsplatformdatasets_v1.types.DeleteDatasetRequest, dict]) – The request object. Request to delete a dataset.
name (str) –
Required. The name of the dataset to delete. Format: projects/{project}/datasets/{dataset_id}
This corresponds to the
namefield on therequestinstance; ifrequestis 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, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- fetch_dataset_errors(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.FetchDatasetErrorsRequest, dict]] = None, *, dataset: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.pagers.FetchDatasetErrorsPager[source]¶
Gets all the errors of a dataset.
# 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.maps import mapsplatformdatasets_v1 def sample_fetch_dataset_errors(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.FetchDatasetErrorsRequest( dataset="dataset_value", ) # Make the request page_result = client.fetch_dataset_errors(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.maps.mapsplatformdatasets_v1.types.FetchDatasetErrorsRequest, dict]) – The request object. Request to list detailed errors belonging to a dataset.
dataset (str) –
Required. The name of the dataset to list all the errors for. Format: projects/{project}/datasets/{dataset_id}
This corresponds to the
datasetfield on therequestinstance; ifrequestis 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, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
Response object of FetchDatasetErrors. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.pagers.FetchDatasetErrorsPager
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- get_dataset(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.GetDatasetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapsplatformdatasets_v1.types.dataset.Dataset[source]¶
Gets the dataset.
# 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.maps import mapsplatformdatasets_v1 def sample_get_dataset(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.GetDatasetRequest( name="name_value", ) # Make the request response = client.get_dataset(request=request) # Handle the response print(response)
- Parameters
request (Union[google.maps.mapsplatformdatasets_v1.types.GetDatasetRequest, dict]) – The request object. Request to get the specified dataset.
name (str) –
Required. Resource name. Format: projects/{project}/datasets/{dataset_id}
Can also fetch some special versions by appending “@” and a tag. Format: projects/{project}/datasets/{dataset_id}@{tag}
Tag “active”: The info of the latest completed version will be included, and NOT_FOUND if the dataset does not have one.
This corresponds to the
namefield on therequestinstance; ifrequestis 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, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
A representation of a dataset resource.
- Return type
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
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.
- Parameters
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.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- list_datasets(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.ListDatasetsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.pagers.ListDatasetsPager[source]¶
Lists all the datasets for the specified project.
# 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.maps import mapsplatformdatasets_v1 def sample_list_datasets(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.ListDatasetsRequest( parent="parent_value", ) # Make the request page_result = client.list_datasets(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.maps.mapsplatformdatasets_v1.types.ListDatasetsRequest, dict]) – The request object. Request to list datasets for the project.
parent (str) –
Required. The name of the project to list all the datasets for. Format: projects/{project}
This corresponds to the
parentfield on therequestinstance; ifrequestis 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, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
Response object of ListDatasets.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.pagers.ListDatasetsPager
- static parse_common_billing_account_path(path: str) Dict[str, str][source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str][source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str][source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str][source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str][source]¶
Parse a project path into its component segments.
- static parse_dataset_path(path: str) Dict[str, str][source]¶
Parses a dataset path into its component segments.
- property transport: google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.transports.base.MapsPlatformDatasetsTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
MapsPlatformDatasetsTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
The universe domain used by the client instance.
- Return type
- update_dataset_metadata(request: Optional[Union[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.UpdateDatasetMetadataRequest, dict]] = None, *, dataset: Optional[google.maps.mapsplatformdatasets_v1.types.dataset.Dataset] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapsplatformdatasets_v1.types.dataset.Dataset[source]¶
Updates the metadata for the dataset.
# 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.maps import mapsplatformdatasets_v1 def sample_update_dataset_metadata(): # Create a client client = mapsplatformdatasets_v1.MapsPlatformDatasetsClient() # Initialize request argument(s) request = mapsplatformdatasets_v1.UpdateDatasetMetadataRequest( ) # Make the request response = client.update_dataset_metadata(request=request) # Handle the response print(response)
- Parameters
request (Union[google.maps.mapsplatformdatasets_v1.types.UpdateDatasetMetadataRequest, dict]) – The request object. Request to update the metadata fields of the dataset.
dataset (google.maps.mapsplatformdatasets_v1.types.Dataset) –
Required. Resource name of the dataset to update. Format: projects/{project}/datasets/{dataset_id}
This corresponds to the
datasetfield on therequestinstance; ifrequestis provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields to be updated.
The value “*” is used for full replacement (default).
This corresponds to the
update_maskfield on therequestinstance; ifrequestis 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, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- Returns
A representation of a dataset resource.
- Return type
- class google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.pagers.FetchDatasetErrorsAsyncPager(method: Callable[[...], Awaitable[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.FetchDatasetErrorsResponse]], request: google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.FetchDatasetErrorsRequest, response: google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.FetchDatasetErrorsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]¶
A pager for iterating through
fetch_dataset_errorsrequests.This class thinly wraps an initial
google.maps.mapsplatformdatasets_v1.types.FetchDatasetErrorsResponseobject, and provides an__aiter__method to iterate through itserrorsfield.If there are more pages, the
__aiter__method will make additionalFetchDatasetErrorsrequests and continue to iterate through theerrorsfield on the corresponding responses.All the usual
google.maps.mapsplatformdatasets_v1.types.FetchDatasetErrorsResponseattributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.maps.mapsplatformdatasets_v1.types.FetchDatasetErrorsRequest) – The initial request object.
response (google.maps.mapsplatformdatasets_v1.types.FetchDatasetErrorsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- class google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.pagers.FetchDatasetErrorsPager(method: Callable[[...], google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.FetchDatasetErrorsResponse], request: google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.FetchDatasetErrorsRequest, response: google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.FetchDatasetErrorsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]¶
A pager for iterating through
fetch_dataset_errorsrequests.This class thinly wraps an initial
google.maps.mapsplatformdatasets_v1.types.FetchDatasetErrorsResponseobject, and provides an__iter__method to iterate through itserrorsfield.If there are more pages, the
__iter__method will make additionalFetchDatasetErrorsrequests and continue to iterate through theerrorsfield on the corresponding responses.All the usual
google.maps.mapsplatformdatasets_v1.types.FetchDatasetErrorsResponseattributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.maps.mapsplatformdatasets_v1.types.FetchDatasetErrorsRequest) – The initial request object.
response (google.maps.mapsplatformdatasets_v1.types.FetchDatasetErrorsResponse) – The initial response object.
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, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- class google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.pagers.ListDatasetsAsyncPager(method: Callable[[...], Awaitable[google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.ListDatasetsResponse]], request: google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.ListDatasetsRequest, response: google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.ListDatasetsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]¶
A pager for iterating through
list_datasetsrequests.This class thinly wraps an initial
google.maps.mapsplatformdatasets_v1.types.ListDatasetsResponseobject, and provides an__aiter__method to iterate through itsdatasetsfield.If there are more pages, the
__aiter__method will make additionalListDatasetsrequests and continue to iterate through thedatasetsfield on the corresponding responses.All the usual
google.maps.mapsplatformdatasets_v1.types.ListDatasetsResponseattributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.maps.mapsplatformdatasets_v1.types.ListDatasetsRequest) – The initial request object.
response (google.maps.mapsplatformdatasets_v1.types.ListDatasetsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
- class google.maps.mapsplatformdatasets_v1.services.maps_platform_datasets.pagers.ListDatasetsPager(method: Callable[[...], google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.ListDatasetsResponse], request: google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.ListDatasetsRequest, response: google.maps.mapsplatformdatasets_v1.types.maps_platform_datasets.ListDatasetsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]¶
A pager for iterating through
list_datasetsrequests.This class thinly wraps an initial
google.maps.mapsplatformdatasets_v1.types.ListDatasetsResponseobject, and provides an__iter__method to iterate through itsdatasetsfield.If there are more pages, the
__iter__method will make additionalListDatasetsrequests and continue to iterate through thedatasetsfield on the corresponding responses.All the usual
google.maps.mapsplatformdatasets_v1.types.ListDatasetsResponseattributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.maps.mapsplatformdatasets_v1.types.ListDatasetsRequest) – The initial request object.
response (google.maps.mapsplatformdatasets_v1.types.ListDatasetsResponse) – The initial response object.
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, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.