com.google.cloud.aiplatform.v1

Class DeploymentResourcePoolServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<DeploymentResourcePoolServiceSettings>

com.google.cloud.aiplatform.v1.DeploymentResourcePoolServiceSettings

@Generated(value="by gapic-generator-java")
public class DeploymentResourcePoolServiceSettings
extends com.google.api.gax.rpc.ClientSettings<DeploymentResourcePoolServiceSettings>

Settings class to configure an instance of DeploymentResourcePoolServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getDeploymentResourcePool:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DeploymentResourcePoolServiceSettings.Builder deploymentResourcePoolServiceSettingsBuilder =
     DeploymentResourcePoolServiceSettings.newBuilder();
 deploymentResourcePoolServiceSettingsBuilder
     .getDeploymentResourcePoolSettings()
     .setRetrySettings(
         deploymentResourcePoolServiceSettingsBuilder
             .getDeploymentResourcePoolSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 DeploymentResourcePoolServiceSettings deploymentResourcePoolServiceSettings =
     deploymentResourcePoolServiceSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createDeploymentResourcePool:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DeploymentResourcePoolServiceSettings.Builder deploymentResourcePoolServiceSettingsBuilder =
     DeploymentResourcePoolServiceSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 deploymentResourcePoolServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeploymentResourcePoolServiceSettings.Builder Builder for DeploymentResourcePoolServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeploymentResourcePoolServiceSettings(DeploymentResourcePoolServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static DeploymentResourcePoolServiceSettings	create(DeploymentResourcePoolServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateDeploymentResourcePoolRequest,DeploymentResourcePool,CreateDeploymentResourcePoolOperationMetadata>	createDeploymentResourcePoolOperationSettings() Returns the object with the settings used for calls to createDeploymentResourcePool.
com.google.api.gax.rpc.UnaryCallSettings<CreateDeploymentResourcePoolRequest,com.google.longrunning.Operation>	createDeploymentResourcePoolSettings() Returns the object with the settings used for calls to createDeploymentResourcePool.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteDeploymentResourcePoolRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteDeploymentResourcePoolOperationSettings() Returns the object with the settings used for calls to deleteDeploymentResourcePool.
com.google.api.gax.rpc.UnaryCallSettings<DeleteDeploymentResourcePoolRequest,com.google.longrunning.Operation>	deleteDeploymentResourcePoolSettings() Returns the object with the settings used for calls to deleteDeploymentResourcePool.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetDeploymentResourcePoolRequest,DeploymentResourcePool>	getDeploymentResourcePoolSettings() Returns the object with the settings used for calls to getDeploymentResourcePool.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
com.google.api.gax.rpc.PagedCallSettings<ListDeploymentResourcePoolsRequest,ListDeploymentResourcePoolsResponse,DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse>	listDeploymentResourcePoolsSettings() Returns the object with the settings used for calls to listDeploymentResourcePools.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,DeploymentResourcePoolServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
static DeploymentResourcePoolServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static DeploymentResourcePoolServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.PagedCallSettings<QueryDeployedModelsRequest,QueryDeployedModelsResponse,DeploymentResourcePoolServiceClient.QueryDeployedModelsPagedResponse>	queryDeployedModelsSettings() Returns the object with the settings used for calls to queryDeployedModels.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
DeploymentResourcePoolServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateDeploymentResourcePoolRequest,DeploymentResourcePool,UpdateDeploymentResourcePoolOperationMetadata>	updateDeploymentResourcePoolOperationSettings() Returns the object with the settings used for calls to updateDeploymentResourcePool.
com.google.api.gax.rpc.UnaryCallSettings<UpdateDeploymentResourcePoolRequest,com.google.longrunning.Operation>	updateDeploymentResourcePoolSettings() Returns the object with the settings used for calls to updateDeploymentResourcePool.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeploymentResourcePoolServiceSettings

protected DeploymentResourcePoolServiceSettings(DeploymentResourcePoolServiceSettings.Builder settingsBuilder)
                                         throws IOException

Throws:

IOException

Method Detail

createDeploymentResourcePoolSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateDeploymentResourcePoolRequest,com.google.longrunning.Operation> createDeploymentResourcePoolSettings()

Returns the object with the settings used for calls to createDeploymentResourcePool.

createDeploymentResourcePoolOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateDeploymentResourcePoolRequest,DeploymentResourcePool,CreateDeploymentResourcePoolOperationMetadata> createDeploymentResourcePoolOperationSettings()

Returns the object with the settings used for calls to createDeploymentResourcePool.

getDeploymentResourcePoolSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetDeploymentResourcePoolRequest,DeploymentResourcePool> getDeploymentResourcePoolSettings()

Returns the object with the settings used for calls to getDeploymentResourcePool.

listDeploymentResourcePoolsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListDeploymentResourcePoolsRequest,ListDeploymentResourcePoolsResponse,DeploymentResourcePoolServiceClient.ListDeploymentResourcePoolsPagedResponse> listDeploymentResourcePoolsSettings()

Returns the object with the settings used for calls to listDeploymentResourcePools.

updateDeploymentResourcePoolSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateDeploymentResourcePoolRequest,com.google.longrunning.Operation> updateDeploymentResourcePoolSettings()

Returns the object with the settings used for calls to updateDeploymentResourcePool.

updateDeploymentResourcePoolOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateDeploymentResourcePoolRequest,DeploymentResourcePool,UpdateDeploymentResourcePoolOperationMetadata> updateDeploymentResourcePoolOperationSettings()

Returns the object with the settings used for calls to updateDeploymentResourcePool.

deleteDeploymentResourcePoolSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteDeploymentResourcePoolRequest,com.google.longrunning.Operation> deleteDeploymentResourcePoolSettings()

Returns the object with the settings used for calls to deleteDeploymentResourcePool.

deleteDeploymentResourcePoolOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteDeploymentResourcePoolRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteDeploymentResourcePoolOperationSettings()

Returns the object with the settings used for calls to deleteDeploymentResourcePool.

queryDeployedModelsSettings

public com.google.api.gax.rpc.PagedCallSettings<QueryDeployedModelsRequest,QueryDeployedModelsResponse,DeploymentResourcePoolServiceClient.QueryDeployedModelsPagedResponse> queryDeployedModelsSettings()

Returns the object with the settings used for calls to queryDeployedModels.

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,DeploymentResourcePoolServiceClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

getLocationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

Returns the object with the settings used for calls to setIamPolicy.

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

Returns the object with the settings used for calls to getIamPolicy.

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

Returns the object with the settings used for calls to testIamPermissions.

create

public static final DeploymentResourcePoolServiceSettings create(DeploymentResourcePoolServiceStubSettings stub)
                                                          throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static DeploymentResourcePoolServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static DeploymentResourcePoolServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public DeploymentResourcePoolServiceSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<DeploymentResourcePoolServiceSettings>