Package Methods (1.11.0)

Summary of entries of Methods for optimization.

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient

  FleetRoutingAsyncClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 optimization_v1 
 . 
 services 
 . 
 fleet_routing 
 . 
 transports 
 . 
 base 
 . 
 FleetRoutingTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 optimization_v1 
 . 
 services 
 . 
 fleet_routing 
 . 
 transports 
 . 
 base 
 . 
 FleetRoutingTransport 
 ]]] 
 = 
 'grpc_asyncio' 
 , 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
 

Instantiates the fleet routing async client.

See more: google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.batch_optimize_tours

  batch_optimize_tours 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 optimization_v1 
 . 
 types 
 . 
 fleet_routing 
 . 
 BatchOptimizeToursRequest 
 , 
 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 
 

Optimizes vehicle tours for one or more OptimizeToursRequest messages as a batch.

See more: google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.batch_optimize_tours

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.common_location_path

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

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 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.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.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.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.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.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.from_service_account_json

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.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.

See more: google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.get_operation

  get_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 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 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 Operation 
 

Gets the latest state of a long-running operation.

See more: google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.get_operation

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.get_transport_class

  get_transport_class 
 ( 
 label 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ) 
 - 
> typing 
 . 
 Type 
 [ 
 google 
 . 
 cloud 
 . 
 optimization_v1 
 . 
 services 
 . 
 fleet_routing 
 . 
 transports 
 . 
 base 
 . 
 FleetRoutingTransport 
 ] 
 

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.optimize_tours

  optimize_tours 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 optimization_v1 
 . 
 types 
 . 
 fleet_routing 
 . 
 OptimizeToursRequest 
 , 
 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 
 . 
 optimization_v1 
 . 
 types 
 . 
 fleet_routing 
 . 
 OptimizeToursResponse 
 

Sends an OptimizeToursRequest containing a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoute \ s, which are a set of routes to be performed by vehicles minimizing the overall cost.

See more: google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.optimize_tours

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

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.parse_common_folder_path

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

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.parse_common_location_path

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

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.parse_common_organization_path

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

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingAsyncClient.parse_common_project_path

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

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient

  FleetRoutingClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 optimization_v1 
 . 
 services 
 . 
 fleet_routing 
 . 
 transports 
 . 
 base 
 . 
 FleetRoutingTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 optimization_v1 
 . 
 services 
 . 
 fleet_routing 
 . 
 transports 
 . 
 base 
 . 
 FleetRoutingTransport 
 ]]] 
 = 
 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 
 = 
 

Instantiates the fleet routing client.

See more: google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.__exit__

  __exit__ 
 ( 
 type 
 , 
 value 
 , 
 traceback 
 ) 
 

Releases underlying transport's resources.

See more: google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient. exit

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.batch_optimize_tours

  batch_optimize_tours 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 optimization_v1 
 . 
 types 
 . 
 fleet_routing 
 . 
 BatchOptimizeToursRequest 
 , 
 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 
 

Optimizes vehicle tours for one or more OptimizeToursRequest messages as a batch.

See more: google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.batch_optimize_tours

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.common_location_path

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

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 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.optimization_v1.services.fleet_routing.FleetRoutingClient.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.optimization_v1.services.fleet_routing.FleetRoutingClient.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.optimization_v1.services.fleet_routing.FleetRoutingClient.from_service_account_json

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.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.optimization_v1.services.fleet_routing.FleetRoutingClient.get_operation

  get_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 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 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 Operation 
 

Gets the latest state of a long-running operation.

See more: google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.get_operation

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.optimize_tours

  optimize_tours 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 optimization_v1 
 . 
 types 
 . 
 fleet_routing 
 . 
 OptimizeToursRequest 
 , 
 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 
 . 
 optimization_v1 
 . 
 types 
 . 
 fleet_routing 
 . 
 OptimizeToursResponse 
 

Sends an OptimizeToursRequest containing a ShipmentModel and returns an OptimizeToursResponse containing ShipmentRoute \ s, which are a set of routes to be performed by vehicles minimizing the overall cost.

See more: google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.optimize_tours

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

Parse a billing_account path into its component segments.

See more: google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.parse_common_billing_account_path

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.parse_common_folder_path

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

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.parse_common_location_path

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

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.parse_common_organization_path

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

google.cloud.optimization_v1.services.fleet_routing.FleetRoutingClient.parse_common_project_path

  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 
Create a Mobile Website
View Site in Mobile | Classic
Share by: