# Class UsageServiceAsyncClient (0.5.0)

0.5.0 (latest) 0.4.0 0.3.0 0.2.0 0.1.0

    UsageServiceAsyncClient(
        *,
        credentials: typing.Optional[google.auth.credentials.Credentials] = None,
        transport: typing.Optional[
            typing.Union[
                str,
                google.cloud.capacityplanner_v1beta.services.usage_service.transports.base.UsageServiceTransport,
                typing.Callable[
                    [...],
                    google.cloud.capacityplanner_v1beta.services.usage_service.transports.base.UsageServiceTransport,
                ],
            ]
        ] = "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
    )

Provides access to historical and forecasted usage data.

## 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** |
| `UsageServiceTransport` | 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

### UsageServiceAsyncClient

    UsageServiceAsyncClient(
        *,
        credentials: typing.Optional[google.auth.credentials.Credentials] = None,
        transport: typing.Optional[
            typing.Union[
                str,
                google.cloud.capacityplanner_v1beta.services.usage_service.transports.base.UsageServiceTransport,
                typing.Callable[
                    [...],
                    google.cloud.capacityplanner_v1beta.services.usage_service.transports.base.UsageServiceTransport,
                ],
            ]
        ] = "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
    )

Instantiates the usage service async 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,UsageServiceTransport,Callable[..., UsageServiceTransport]]]` 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 UsageServiceTransport 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 `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. |

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

### export_forecasts

    export_forecasts(
        request: typing.Optional[
            typing.Union[
                google.cloud.capacityplanner_v1beta.types.usage_service.ExportForecastsRequest,
                dict,
            ]
        ] = None,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary_async.AsyncRetry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.api_core.operation_async.AsyncOperation

Exports forecasted usage data requested by user into
either an existing Cloud Storage bucket or a BigQuery
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 https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest

    async def sample_export_forecasts():
        # Create a client
        client = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html()

        # Initialize request argument(s)
        output_config = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.OutputConfig.html()
        output_config.gcs_destination.bucket = "bucket_value"
        output_config.gcs_destination.object_ = "object__value"

        request = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportForecastsRequest.html(
            parent="parent_value",
            resource_type="resource_type_value",
            output_config=output_config,
        )

        # Make the request
        operation = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html#google_cloud_capacityplanner_v1beta_services_usage_service_UsageServiceAsyncClient_export_forecasts(request=request)

        print("Waiting for operation to complete...")

        response = await operation.result()

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportForecastsRequest, dict]]` The request object. The `ExportForecasts` request Next : 13 |
| `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** ||
|---|---|
| **Type** | **Description** |
| `google.api_core.operation_async.AsyncOperation` | An object representing a long-running operation. The result type for the operation will be [ExportForecastsResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportForecastsResponse) A response message for \[UsageService.ExportForecasts\]. |

### export_reservations_usage

    export_reservations_usage(
        request: typing.Optional[
            typing.Union[
                google.cloud.capacityplanner_v1beta.types.usage_service.ExportReservationsUsageRequest,
                dict,
            ]
        ] = None,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary_async.AsyncRetry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.api_core.operation_async.AsyncOperation

Exports reservations usage data requested by user
into either an existing Cloud Storage bucket or a
new/existing BigQuery 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 https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest

    async def sample_export_reservations_usage():
        # Create a client
        client = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html()

        # Initialize request argument(s)
        output_config = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.OutputConfig.html()
        output_config.gcs_destination.bucket = "bucket_value"
        output_config.gcs_destination.object_ = "object__value"

        request = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportReservationsUsageRequest.html(
            machine_family="machine_family_value",
            parent="parent_value",
            cloud_resource_type="cloud_resource_type_value",
            usage_aggregation_method="P99",
            output_config=output_config,
        )

        # Make the request
        operation = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html#google_cloud_capacityplanner_v1beta_services_usage_service_UsageServiceAsyncClient_export_reservations_usage(request=request)

        print("Waiting for operation to complete...")

        response = await operation.result()

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportReservationsUsageRequest, dict]]` The request object. The `ExportReservationsUsage` request |
| `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** ||
|---|---|
| **Type** | **Description** |
| `google.api_core.operation_async.AsyncOperation` | An object representing a long-running operation. The result type for the operation will be [ExportReservationsUsageResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportReservationsUsageResponse) A response message for \[UsageService.ExportReservationsUsage\]. |

### export_usage_histories

    export_usage_histories(
        request: typing.Optional[
            typing.Union[
                google.cloud.capacityplanner_v1beta.types.usage_service.ExportUsageHistoriesRequest,
                dict,
            ]
        ] = None,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary_async.AsyncRetry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.api_core.operation_async.AsyncOperation

Exports historical usage data requested by user into
either an existing Cloud Storage bucket or a BigQuery
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 https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest

    async def sample_export_usage_histories():
        # Create a client
        client = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html()

        # Initialize request argument(s)
        output_config = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.OutputConfig.html()
        output_config.gcs_destination.bucket = "bucket_value"
        output_config.gcs_destination.object_ = "object__value"

        request = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportUsageHistoriesRequest.html(
            parent="parent_value",
            resource_type="resource_type_value",
            output_config=output_config,
        )

        # Make the request
        operation = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html#google_cloud_capacityplanner_v1beta_services_usage_service_UsageServiceAsyncClient_export_usage_histories(request=request)

        print("Waiting for operation to complete...")

        response = await operation.result()

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportUsageHistoriesRequest, dict]]` The request object. The `ExportUsageHistories` request Next : 12 |
| `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** ||
|---|---|
| **Type** | **Description** |
| `google.api_core.operation_async.AsyncOperation` | An object representing a long-running operation. The result type for the operation will be [ExportUsageHistoriesResponse](https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.ExportUsageHistoriesResponse) A response message for \[UsageService.ExportUsageHistories\]. |

### forecast_path

    forecast_path(project: str, location: str, forecast: str) -> str

Returns a fully-qualified forecast 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** |
| `UsageServiceAsyncClient` | 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** |
| `UsageServiceAsyncClient` | 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** |
| `UsageServiceAsyncClient` | 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,
    )

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

### get_transport_class

    get_transport_class(
        label: typing.Optional[str] = None,
    ) -> typing.Type[
        google.cloud.capacityplanner_v1beta.services.usage_service.transports.base.UsageServiceTransport
    ]

Returns an appropriate transport class.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `label` | `typing.Optional[str]` The name of the desired transport. If none is provided, then the first transport in the registry is used. |

### 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_forecast_path

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

Parses a forecast path into its component segments.

### parse_reservation_path

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

Parses a reservation path into its component segments.

### query_forecasts

    query_forecasts(
        request: typing.Optional[
            typing.Union[
                google.cloud.capacityplanner_v1beta.types.usage_service.QueryForecastsRequest,
                dict,
            ]
        ] = None,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary_async.AsyncRetry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.capacityplanner_v1beta.types.usage_service.QueryForecastsResponse

Returns a list of the forecasts that are in the
parent parameter and match your specified filters.

    # 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 https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest

    async def sample_query_forecasts():
        # Create a client
        client = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html()

        # Initialize request argument(s)
        request = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryForecastsRequest.html(
            parent="parent_value",
            cloud_resource_type="cloud_resource_type_value",
        )

        # Make the request
        response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html#google_cloud_capacityplanner_v1beta_services_usage_service_UsageServiceAsyncClient_query_forecasts(request=request)

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryForecastsRequest, dict]]` The request object. The `QueryForecasts` request. Next : 14 |
| `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** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryForecastsResponse` | The QueryForecasts response. |

### query_reservations

    query_reservations(
        request: typing.Optional[
            typing.Union[
                google.cloud.capacityplanner_v1beta.types.usage_service.QueryReservationsRequest,
                dict,
            ]
        ] = None,
        *,
        parent: typing.Optional[str] = None,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary_async.AsyncRetry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> google.cloud.capacityplanner_v1beta.types.usage_service.QueryReservationsResponse

Returns a list of the reservations that are in the
parent parameter and match your specified filters.

    # 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 https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest

    async def sample_query_reservations():
        # Create a client
        client = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html()

        # Initialize request argument(s)
        request = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsRequest.html(
            parent="parent_value",
            cloud_resource_type="cloud_resource_type_value",
            reservation_type="RESERVATION_TYPE_ALL",
            reservation_data_level="RESERVATION_DATA_LEVEL_PER_RESERVATION",
        )

        # Make the request
        response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html#google_cloud_capacityplanner_v1beta_services_usage_service_UsageServiceAsyncClient_query_reservations(request=request)

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsRequest, dict]]` The request object. The `QueryReservations` request. |
| `parent` | `` `str` `` Required. The compute engine resource and location for the time series values to return. The format is: projects/{project}/locations/{location} or organizations/{organization}/locations/{location} or folders/{folder}/locations/{location} This corresponds to the `parent` field on the `request` instance; if `request` is 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** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryReservationsResponse` | The QueryReservations response. |

### query_usage_histories

    query_usage_histories(
        request: typing.Optional[
            typing.Union[
                google.cloud.capacityplanner_v1beta.types.usage_service.QueryUsageHistoriesRequest,
                dict,
            ]
        ] = None,
        *,
        retry: typing.Optional[
            typing.Union[
                google.api_core.retry.retry_unary_async.AsyncRetry,
                google.api_core.gapic_v1.method._MethodDefault,
            ]
        ] = _MethodDefault._DEFAULT_VALUE,
        timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
        metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
    ) -> (
        google.cloud.capacityplanner_v1beta.types.usage_service.QueryUsageHistoriesResponse
    )

Returns a list of the usage histories that are in the
parent parameter and match your specified filters.

    # 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 https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest

    async def sample_query_usage_histories():
        # Create a client
        client = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html()

        # Initialize request argument(s)
        request = https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryUsageHistoriesRequest.html(
            parent="parent_value",
            cloud_resource_type="cloud_resource_type_value",
        )

        # Make the request
        response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.html#google_cloud_capacityplanner_v1beta_services_usage_service_UsageServiceAsyncClient_query_usage_histories(request=request)

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryUsageHistoriesRequest, dict]]` The request object. The `QueryUsageHistories` request. Next : 16 |
| `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** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/google-cloud-capacityplanner/latest/google.cloud.capacityplanner_v1beta.types.QueryUsageHistoriesResponse` | The QueryUsageHistories response. |

### reservation_path

    reservation_path(project: str, location: str, reservation: str) -> str

Returns a fully-qualified reservation string.