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 '/workspace/python-billing/.nox/docfx/lib/python3.9/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>)
A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs.
Properties
transport
Return the transport used by the client instance.
Type | Description |
CloudCatalogTransport | The transport used by the client instance. |
Methods
CloudCatalogAsyncClient
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 '/workspace/python-billing/.nox/docfx/lib/python3.9/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>)
Instantiate the cloud catalog client.
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 |
Union[str,
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 |
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Return a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Return a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Return a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Return a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Return 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
{@api.name} | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
{@api.name} | The constructed client. |
get_transport_class
get_transport_class()
Return an appropriate transport class.
list_services
list_services(request: Optional[google.cloud.billing_v1.types.cloud_catalog.ListServicesRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists all public cloud services.
Name | Description |
request |
The request object. Request message for |
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. |
Type | Description |
| Response message for ListServices . Iterating over this object will yield results and resolve additional pages automatically. |
list_skus
list_skus(request: Optional[google.cloud.billing_v1.types.cloud_catalog.ListSkusRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists all publicly available SKUs for a given cloud service.
Name | Description |
request |
The request object. Request message for |
parent |
Required. The name of the service. Example: "services/DA34-426B-A397". This corresponds to the |
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. |
Type | Description |
| Response message for ListSkus . Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_service_path
parse_service_path(path: str)
Parse a service path into its component segments.
parse_sku_path
parse_sku_path(path: str)
Parse a sku path into its component segments.
service_path
service_path(service: str)
Return a fully-qualified service string.
sku_path
sku_path(service: str, sku: str)
Return a fully-qualified sku string.