As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

CloudCatalog

class google.cloud.billing_v1.services.cloud_catalog.CloudCatalogAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.billing_v1.services.cloud_catalog.transports.base.CloudCatalogTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/usr/lib/python3.10/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs.

Instantiates the cloud catalog 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 (Union[str, CloudCatalogTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static common_billing_account_path(billing_account: str) str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) str

Returns a fully-qualified folder 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.

static common_project_path(project: str) str

Returns a fully-qualified project string.

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

CloudCatalogAsyncClient

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

CloudCatalogAsyncClient

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

CloudCatalogAsyncClient

get_transport_class() Type[google.cloud.billing_v1.services.cloud_catalog.transports.base.CloudCatalogTransport]

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_services(request: Optional[google.cloud.billing_v1.types.cloud_catalog.ListServicesRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.services.cloud_catalog.pagers.ListServicesAsyncPager[source]

Lists all public cloud services.

Parameters
  • request (google.cloud.billing_v1.types.ListServicesRequest) – The request object. Request message for ListServices.

  • 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

Response message for ListServices.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.billing_v1.services.cloud_catalog.pagers.ListServicesAsyncPager

async list_skus(request: Optional[google.cloud.billing_v1.types.cloud_catalog.ListSkusRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.services.cloud_catalog.pagers.ListSkusAsyncPager[source]

Lists all publicly available SKUs for a given cloud service.

Parameters
  • request (google.cloud.billing_v1.types.ListSkusRequest) – The request object. Request message for ListSkus.

  • parent (str) –

    Required. The name of the service. Example: “services/DA34-426B-A397”

    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

Response message for ListSkus.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.billing_v1.services.cloud_catalog.pagers.ListSkusAsyncPager

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_service_path(path: str) Dict[str, str]

Parses a service path into its component segments.

static parse_sku_path(path: str) Dict[str, str]

Parses a sku path into its component segments.

static service_path(service: str) str

Returns a fully-qualified service string.

static sku_path(service: str, sku: str) str

Returns a fully-qualified sku string.

property transport: google.cloud.billing_v1.services.cloud_catalog.transports.base.CloudCatalogTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

CloudCatalogTransport

class google.cloud.billing_v1.services.cloud_catalog.CloudCatalogClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.billing_v1.services.cloud_catalog.transports.base.CloudCatalogTransport]] = None, client_options: 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]

A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs.

Instantiates the cloud catalog 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 (Union[str, CloudCatalogTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

  • 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.

static common_billing_account_path(billing_account: str) str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) str[source]

Returns a fully-qualified folder 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.

static common_project_path(project: str) str[source]

Returns a fully-qualified project string.

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

CloudCatalogClient

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

CloudCatalogClient

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

CloudCatalogClient

list_services(request: Optional[google.cloud.billing_v1.types.cloud_catalog.ListServicesRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.services.cloud_catalog.pagers.ListServicesPager[source]

Lists all public cloud services.

Parameters
  • request (google.cloud.billing_v1.types.ListServicesRequest) – The request object. Request message for ListServices.

  • 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

Response message for ListServices.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.billing_v1.services.cloud_catalog.pagers.ListServicesPager

list_skus(request: Optional[google.cloud.billing_v1.types.cloud_catalog.ListSkusRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.services.cloud_catalog.pagers.ListSkusPager[source]

Lists all publicly available SKUs for a given cloud service.

Parameters
  • request (google.cloud.billing_v1.types.ListSkusRequest) – The request object. Request message for ListSkus.

  • parent (str) –

    Required. The name of the service. Example: “services/DA34-426B-A397”

    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

Response message for ListSkus.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.billing_v1.services.cloud_catalog.pagers.ListSkusPager

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_service_path(path: str) Dict[str, str][source]

Parses a service path into its component segments.

static parse_sku_path(path: str) Dict[str, str][source]

Parses a sku path into its component segments.

static service_path(service: str) str[source]

Returns a fully-qualified service string.

static sku_path(service: str, sku: str) str[source]

Returns a fully-qualified sku string.

property transport: google.cloud.billing_v1.services.cloud_catalog.transports.base.CloudCatalogTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

CloudCatalogTransport

class google.cloud.billing_v1.services.cloud_catalog.pagers.ListServicesAsyncPager(method: Callable[[...], Awaitable[google.cloud.billing_v1.types.cloud_catalog.ListServicesResponse]], request: google.cloud.billing_v1.types.cloud_catalog.ListServicesRequest, response: google.cloud.billing_v1.types.cloud_catalog.ListServicesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_services requests.

This class thinly wraps an initial google.cloud.billing_v1.types.ListServicesResponse object, and provides an __aiter__ method to iterate through its services field.

If there are more pages, the __aiter__ method will make additional ListServices requests and continue to iterate through the services field on the corresponding responses.

All the usual google.cloud.billing_v1.types.ListServicesResponse attributes 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
class google.cloud.billing_v1.services.cloud_catalog.pagers.ListServicesPager(method: Callable[[...], google.cloud.billing_v1.types.cloud_catalog.ListServicesResponse], request: google.cloud.billing_v1.types.cloud_catalog.ListServicesRequest, response: google.cloud.billing_v1.types.cloud_catalog.ListServicesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_services requests.

This class thinly wraps an initial google.cloud.billing_v1.types.ListServicesResponse object, and provides an __iter__ method to iterate through its services field.

If there are more pages, the __iter__ method will make additional ListServices requests and continue to iterate through the services field on the corresponding responses.

All the usual google.cloud.billing_v1.types.ListServicesResponse attributes 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
class google.cloud.billing_v1.services.cloud_catalog.pagers.ListSkusAsyncPager(method: Callable[[...], Awaitable[google.cloud.billing_v1.types.cloud_catalog.ListSkusResponse]], request: google.cloud.billing_v1.types.cloud_catalog.ListSkusRequest, response: google.cloud.billing_v1.types.cloud_catalog.ListSkusResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_skus requests.

This class thinly wraps an initial google.cloud.billing_v1.types.ListSkusResponse object, and provides an __aiter__ method to iterate through its skus field.

If there are more pages, the __aiter__ method will make additional ListSkus requests and continue to iterate through the skus field on the corresponding responses.

All the usual google.cloud.billing_v1.types.ListSkusResponse attributes 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
class google.cloud.billing_v1.services.cloud_catalog.pagers.ListSkusPager(method: Callable[[...], google.cloud.billing_v1.types.cloud_catalog.ListSkusResponse], request: google.cloud.billing_v1.types.cloud_catalog.ListSkusRequest, response: google.cloud.billing_v1.types.cloud_catalog.ListSkusResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_skus requests.

This class thinly wraps an initial google.cloud.billing_v1.types.ListSkusResponse object, and provides an __iter__ method to iterate through its skus field.

If there are more pages, the __iter__ method will make additional ListSkus requests and continue to iterate through the skus field on the corresponding responses.

All the usual google.cloud.billing_v1.types.ListSkusResponse attributes 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