Class DeploymentResourcePoolServiceClient (1.27.1)

  DeploymentResourcePoolServiceClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 aiplatform_v1beta1 
 . 
 services 
 . 
 deployment_resource_pool_service 
 . 
 transports 
 . 
 base 
 . 
 DeploymentResourcePoolServiceTransport 
 ]] 
 = 
 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 
 object 
> )

A service that manages the DeploymentResourcePool resource.

Properties

transport

Returns the transport used by the client instance.

Returns
Type
Description
DeploymentResourcePoolServiceTransport
The transport used by the client instance.

Methods

DeploymentResourcePoolServiceClient

  DeploymentResourcePoolServiceClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 aiplatform_v1beta1 
 . 
 services 
 . 
 deployment_resource_pool_service 
 . 
 transports 
 . 
 base 
 . 
 DeploymentResourcePoolServiceTransport 
 ]] 
 = 
 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 
 object 
> )

Instantiates the deployment resource pool service 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
Union[str, DeploymentResourcePoolServiceTransport]

The transport to use. 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. 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.

Exceptions
Type
Description
google.auth.exceptions.MutualTLSChannelError
If mutual TLS transport creation failed for any reason.

__exit__

  __exit__ 
 ( 
 type 
 , 
 value 
 , 
 traceback 
 )

Releases underlying transport's resources.

cancel_operation

  cancel_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 CancelOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED .

Parameters
Name
Description
request
.operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.

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.

  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.

create_deployment_resource_pool

  create_deployment_resource_pool 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1beta1 
 . 
 types 
 . 
 deployment_resource_pool_service 
 . 
 CreateDeploymentResourcePoolRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 deployment_resource_pool 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1beta1 
 . 
 types 
 . 
 deployment_resource_pool 
 . 
 DeploymentResourcePool 
 ] 
 = 
 None 
 , 
 deployment_resource_pool_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation

Create a DeploymentResourcePool.

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

def sample_create_deployment_resource_pool():
    # Create a client
    client = aiplatform_v1beta1.DeploymentResourcePoolServiceClient()

    # Initialize request argument(s)
    deployment_resource_pool = aiplatform_v1beta1.DeploymentResourcePool()
    deployment_resource_pool.dedicated_resources.min_replica_count = 1803

    request = aiplatform_v1beta1.CreateDeploymentResourcePoolRequest(
        parent="parent_value",
        deployment_resource_pool=deployment_resource_pool,
        deployment_resource_pool_id="deployment_resource_pool_id_value",
    )

    # Make the request
    operation = client.create_deployment_resource_pool(request=request)

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name
Description
request
Union[ google.cloud.aiplatform_v1beta1.types.CreateDeploymentResourcePoolRequest , dict]

The request object. Request message for CreateDeploymentResourcePool method.

parent
str

Required. The parent location resource where this DeploymentResourcePool will be created. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

deployment_resource_pool
google.cloud.aiplatform_v1beta1.types.DeploymentResourcePool

Required. The DeploymentResourcePool to create. This corresponds to the deployment_resource_pool field on the request instance; if request is provided, this should not be set.

deployment_resource_pool_id
str

Required. The ID to use for the DeploymentResourcePool, which will become the final component of the DeploymentResourcePool's resource name. The maximum length is 63 characters, and valid characters are /^ a-z ?$/ . This corresponds to the deployment_resource_pool_id 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
Type
Description
google.api_core.operation.Operation
An object representing a long-running operation. The result type for the operation will be DeploymentResourcePool A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources.

delete_deployment_resource_pool

  delete_deployment_resource_pool 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1beta1 
 . 
 types 
 . 
 deployment_resource_pool_service 
 . 
 DeleteDeploymentResourcePoolRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation

Delete a DeploymentResourcePool.

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

def sample_delete_deployment_resource_pool():
    # Create a client
    client = aiplatform_v1beta1.DeploymentResourcePoolServiceClient()

    # Initialize request argument(s)
    request = aiplatform_v1beta1.DeleteDeploymentResourcePoolRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_deployment_resource_pool(request=request)

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name
Description
request
Union[ google.cloud.aiplatform_v1beta1.types.DeleteDeploymentResourcePoolRequest , dict]

The request object. Request message for DeleteDeploymentResourcePool method.

name
str

Required. The name of the DeploymentResourcePool to delete. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} This corresponds to the name 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
Type
Description
google.api_core.operation.Operation
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_operation

  delete_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 DeleteOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED .

Parameters
Name
Description
request
.operations_pb2.DeleteOperationRequest

The request object. Request message for DeleteOperation method.

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.

deployment_resource_pool_path

  deployment_resource_pool_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 deployment_resource_pool 
 : 
 str 
 ) 
 - 
> str

Returns a fully-qualified deployment_resource_pool string.

endpoint_path

  endpoint_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 endpoint 
 : 
 str 
 ) 
 - 
> str

Returns a fully-qualified endpoint string.

  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
DeploymentResourcePoolServiceClient
The constructed client.
  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
DeploymentResourcePoolServiceClient
The constructed client.
  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
DeploymentResourcePoolServiceClient
The constructed client.

get_deployment_resource_pool

  get_deployment_resource_pool 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1beta1 
 . 
 types 
 . 
 deployment_resource_pool_service 
 . 
 GetDeploymentResourcePoolRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> ( 
 google 
 . 
 cloud 
 . 
 aiplatform_v1beta1 
 . 
 types 
 . 
 deployment_resource_pool 
 . 
 DeploymentResourcePool 
 )

Get a DeploymentResourcePool.

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

def sample_get_deployment_resource_pool():
    # Create a client
    client = aiplatform_v1beta1.DeploymentResourcePoolServiceClient()

    # Initialize request argument(s)
    request = aiplatform_v1beta1.GetDeploymentResourcePoolRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_deployment_resource_pool(request=request)

    # Handle the response
    print(response)
Parameters
Name
Description
request
Union[ google.cloud.aiplatform_v1beta1.types.GetDeploymentResourcePoolRequest , dict]

The request object. Request message for GetDeploymentResourcePool method.

name
str

Required. The name of the DeploymentResourcePool to retrieve. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} This corresponds to the name 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
Type
Description
google.cloud.aiplatform_v1beta1.types.DeploymentResourcePool
A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources.

get_iam_policy

  get_iam_policy 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 GetIamPolicyRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 policy_pb2 
 . 
 Policy

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Parameters
Name
Description
request
.iam_policy_pb2.GetIamPolicyRequest

The request object. Request message for GetIamPolicy method.

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
Type
Description
.policy_pb2.Policy
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings . A binding binds one or more members to a single role . Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition , which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the=""> IAM developer's guide __.

get_location

  get_location 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 GetLocationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 Location

Gets information about a location.

Parameters
Name
Description
request
.location_pb2.GetLocationRequest

The request object. Request message for GetLocation method.

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
Type
Description
.location_pb2.Location
Location object.

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_operation

  get_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 Operation

Gets the latest state of a long-running operation.

Parameters
Name
Description
request
.operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.

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
Type
Description
.operations_pb2.Operation
An Operation object.

list_deployment_resource_pools

  list_deployment_resource_pools 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1beta1 
 . 
 types 
 . 
 deployment_resource_pool_service 
 . 
 ListDeploymentResourcePoolsRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> ( 
 google 
 . 
 cloud 
 . 
 aiplatform_v1beta1 
 . 
 services 
 . 
 deployment_resource_pool_service 
 . 
 pagers 
 . 
 ListDeploymentResourcePoolsPager 
 )

List DeploymentResourcePools in a location.

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

def sample_list_deployment_resource_pools():
    # Create a client
    client = aiplatform_v1beta1.DeploymentResourcePoolServiceClient()

    # Initialize request argument(s)
    request = aiplatform_v1beta1.ListDeploymentResourcePoolsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_deployment_resource_pools(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name
Description
request
Union[ google.cloud.aiplatform_v1beta1.types.ListDeploymentResourcePoolsRequest , dict]

The request object. Request message for ListDeploymentResourcePools method.

parent
str

Required. The parent Location which owns this collection of DeploymentResourcePools. Format: projects/{project}/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.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
Type
Description
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.pagers.ListDeploymentResourcePoolsPager
Response message for ListDeploymentResourcePools method. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

  list_locations 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 ListLocationsRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name
Description
request
.location_pb2.ListLocationsRequest

The request object. Request message for ListLocations method.

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
Type
Description
.location_pb2.ListLocationsResponse
Response message for ListLocations method.

list_operations

  list_operations 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 ListOperationsRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name
Description
request
.operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.

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
Type
Description
.operations_pb2.ListOperationsResponse
Response message for ListOperations method.

model_path

  model_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 model 
 : 
 str 
 ) 
 - 
> str

Returns a fully-qualified model string.

  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_deployment_resource_pool_path

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

Parses a deployment_resource_pool path into its component segments.

parse_endpoint_path

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

Parses a endpoint path into its component segments.

parse_model_path

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

Parses a model path into its component segments.

query_deployed_models

  query_deployed_models 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1beta1 
 . 
 types 
 . 
 deployment_resource_pool_service 
 . 
 QueryDeployedModelsRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 deployment_resource_pool 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> ( 
 google 
 . 
 cloud 
 . 
 aiplatform_v1beta1 
 . 
 services 
 . 
 deployment_resource_pool_service 
 . 
 pagers 
 . 
 QueryDeployedModelsPager 
 )

List DeployedModels that have been deployed on this DeploymentResourcePool.

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

def sample_query_deployed_models():
    # Create a client
    client = aiplatform_v1beta1.DeploymentResourcePoolServiceClient()

    # Initialize request argument(s)
    request = aiplatform_v1beta1.QueryDeployedModelsRequest(
        deployment_resource_pool="deployment_resource_pool_value",
    )

    # Make the request
    page_result = client.query_deployed_models(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name
Description
request
Union[ google.cloud.aiplatform_v1beta1.types.QueryDeployedModelsRequest , dict]

The request object. Request message for QueryDeployedModels method.

deployment_resource_pool
str

Required. The name of the target DeploymentResourcePool to query. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} This corresponds to the deployment_resource_pool 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
Type
Description
google.cloud.aiplatform_v1beta1.services.deployment_resource_pool_service.pagers.QueryDeployedModelsPager
Response message for QueryDeployedModels method. Iterating over this object will yield results and resolve additional pages automatically.

set_iam_policy

  set_iam_policy 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 SetIamPolicyRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 policy_pb2 
 . 
 Policy

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters
Name
Description
request
.iam_policy_pb2.SetIamPolicyRequest

The request object. Request message for SetIamPolicy method.

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
Type
Description
.policy_pb2.Policy
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings . A binding binds one or more members to a single role . Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition , which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the=""> IAM developer's guide __.

test_iam_permissions

  test_iam_permissions 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsResponse

Tests the specified IAM permissions against the IAM access control policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Parameters
Name
Description
request
.iam_policy_pb2.TestIamPermissionsRequest

The request object. Request message for TestIamPermissions method.

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
Type
Description
.iam_policy_pb2.TestIamPermissionsResponse
Response message for TestIamPermissions method.

wait_operation

  wait_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 WaitOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 Operation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.

If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED .

Parameters
Name
Description
request
.operations_pb2.WaitOperationRequest

The request object. Request message for WaitOperation method.

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
Type
Description
.operations_pb2.Operation
An Operation object.