Package Methods (0.2.0)

Summary of entries of Methods for google-cloud-capacityplanner.

google.cloud.capacityplanner_v1beta.services.usage_service.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.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.common_location_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.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.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.export_forecasts

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.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.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.export_reservations_usage

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.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.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.export_usage_histories

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.forecast_path

  forecast_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 forecast 
 : 
 str 
 ) 
 - 
> str 
 
  from_service_account_file 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

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

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.from_service_account_json

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.get_mtls_endpoint_and_cert_source

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.get_transport_class

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.parse_common_folder_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.parse_common_location_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.parse_common_organization_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.parse_common_project_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.parse_forecast_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.parse_reservation_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.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.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.query_forecasts

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.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.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.query_reservations

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.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.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.query_usage_histories

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceAsyncClient.reservation_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient

  UsageServiceClient 
 ( 
 * 
 , 
 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 
 , 
 ], 
 ] 
 ] 
 = 
 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 
 ) 
 

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.__exit__

  __exit__ 
 ( 
 type 
 , 
 value 
 , 
 traceback 
 ) 
 
  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.common_location_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.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 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Exports forecasted usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.export_forecasts

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.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 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Exports reservations usage data requested by user into either an existing Cloud Storage bucket or a new/existing BigQuery table.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.export_reservations_usage

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.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 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Exports historical usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.export_usage_histories

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.forecast_path

  forecast_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 forecast 
 : 
 str 
 ) 
 - 
> str 
 
  from_service_account_file 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

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

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.from_service_account_file

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

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

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.from_service_account_info

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

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

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.from_service_account_json

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.get_mtls_endpoint_and_cert_source

  get_mtls_endpoint_and_cert_source 
 ( 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 ) 
 
  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.parse_common_folder_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.parse_common_location_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.parse_common_organization_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.parse_common_project_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.parse_forecast_path

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

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.parse_reservation_path

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

Parses a reservation path into its component segments.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.parse_reservation_path

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.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 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 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.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.query_forecasts

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.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 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 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.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.query_reservations

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.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 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 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.

See more: google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.query_usage_histories

google.cloud.capacityplanner_v1beta.services.usage_service.UsageServiceClient.reservation_path

  reservation_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 reservation 
 : 
 str 
 ) 
 - 
> str 
 
Design a Mobile Site
View Site in Mobile | Classic
Share by: