com.google.cloud.vertexai.api

Class EndpointServiceSettings

java.lang.Object

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

com.google.cloud.vertexai.api.EndpointServiceSettings

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

Settings class to configure an instance of EndpointServiceClient.

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 getEndpoint:

 // 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
 EndpointServiceSettings.Builder endpointServiceSettingsBuilder =
     EndpointServiceSettings.newBuilder();
 endpointServiceSettingsBuilder
     .getEndpointSettings()
     .setRetrySettings(
         endpointServiceSettingsBuilder
             .getEndpointSettings()
             .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());
 EndpointServiceSettings endpointServiceSettings = endpointServiceSettingsBuilder.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 createEndpoint:

 // 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
 EndpointServiceSettings.Builder endpointServiceSettingsBuilder =
     EndpointServiceSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 endpointServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static EndpointServiceSettings	create(EndpointServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateEndpointRequest,Endpoint,CreateEndpointOperationMetadata>	createEndpointOperationSettings() Returns the object with the settings used for calls to createEndpoint.
com.google.api.gax.rpc.UnaryCallSettings<CreateEndpointRequest,com.google.longrunning.Operation>	createEndpointSettings() Returns the object with the settings used for calls to createEndpoint.
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 gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteEndpointRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteEndpointOperationSettings() Returns the object with the settings used for calls to deleteEndpoint.
com.google.api.gax.rpc.UnaryCallSettings<DeleteEndpointRequest,com.google.longrunning.Operation>	deleteEndpointSettings() Returns the object with the settings used for calls to deleteEndpoint.
com.google.api.gax.rpc.OperationCallSettings<DeployModelRequest,DeployModelResponse,DeployModelOperationMetadata>	deployModelOperationSettings() Returns the object with the settings used for calls to deployModel.
com.google.api.gax.rpc.UnaryCallSettings<DeployModelRequest,com.google.longrunning.Operation>	deployModelSettings() Returns the object with the settings used for calls to deployModel.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetEndpointRequest,Endpoint>	getEndpointSettings() Returns the object with the settings used for calls to getEndpoint.
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<ListEndpointsRequest,ListEndpointsResponse,EndpointServiceClient.ListEndpointsPagedResponse>	listEndpointsSettings() Returns the object with the settings used for calls to listEndpoints.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,EndpointServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.OperationCallSettings<MutateDeployedModelRequest,MutateDeployedModelResponse,MutateDeployedModelOperationMetadata>	mutateDeployedModelOperationSettings() Returns the object with the settings used for calls to mutateDeployedModel.
com.google.api.gax.rpc.UnaryCallSettings<MutateDeployedModelRequest,com.google.longrunning.Operation>	mutateDeployedModelSettings() Returns the object with the settings used for calls to mutateDeployedModel.
static EndpointServiceSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static EndpointServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static EndpointServiceSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
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.
EndpointServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UndeployModelRequest,UndeployModelResponse,UndeployModelOperationMetadata>	undeployModelOperationSettings() Returns the object with the settings used for calls to undeployModel.
com.google.api.gax.rpc.UnaryCallSettings<UndeployModelRequest,com.google.longrunning.Operation>	undeployModelSettings() Returns the object with the settings used for calls to undeployModel.
com.google.api.gax.rpc.OperationCallSettings<UpdateEndpointLongRunningRequest,Endpoint,UpdateEndpointOperationMetadata>	updateEndpointLongRunningOperationSettings() Returns the object with the settings used for calls to updateEndpointLongRunning.
com.google.api.gax.rpc.UnaryCallSettings<UpdateEndpointLongRunningRequest,com.google.longrunning.Operation>	updateEndpointLongRunningSettings() Returns the object with the settings used for calls to updateEndpointLongRunning.
com.google.api.gax.rpc.UnaryCallSettings<UpdateEndpointRequest,Endpoint>	updateEndpointSettings() Returns the object with the settings used for calls to updateEndpoint.

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

EndpointServiceSettings

protected EndpointServiceSettings(EndpointServiceSettings.Builder settingsBuilder)
                           throws IOException

Throws:

IOException

Method Detail

createEndpointSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateEndpointRequest,com.google.longrunning.Operation> createEndpointSettings()

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

createEndpointOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateEndpointRequest,Endpoint,CreateEndpointOperationMetadata> createEndpointOperationSettings()

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

getEndpointSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetEndpointRequest,Endpoint> getEndpointSettings()

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

listEndpointsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListEndpointsRequest,ListEndpointsResponse,EndpointServiceClient.ListEndpointsPagedResponse> listEndpointsSettings()

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

updateEndpointSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateEndpointRequest,Endpoint> updateEndpointSettings()

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

updateEndpointLongRunningSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateEndpointLongRunningRequest,com.google.longrunning.Operation> updateEndpointLongRunningSettings()

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

updateEndpointLongRunningOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateEndpointLongRunningRequest,Endpoint,UpdateEndpointOperationMetadata> updateEndpointLongRunningOperationSettings()

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

deleteEndpointSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteEndpointRequest,com.google.longrunning.Operation> deleteEndpointSettings()

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

deleteEndpointOperationSettings

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

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

deployModelSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeployModelRequest,com.google.longrunning.Operation> deployModelSettings()

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

deployModelOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeployModelRequest,DeployModelResponse,DeployModelOperationMetadata> deployModelOperationSettings()

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

undeployModelSettings

public com.google.api.gax.rpc.UnaryCallSettings<UndeployModelRequest,com.google.longrunning.Operation> undeployModelSettings()

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

undeployModelOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UndeployModelRequest,UndeployModelResponse,UndeployModelOperationMetadata> undeployModelOperationSettings()

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

mutateDeployedModelSettings

public com.google.api.gax.rpc.UnaryCallSettings<MutateDeployedModelRequest,com.google.longrunning.Operation> mutateDeployedModelSettings()

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

mutateDeployedModelOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<MutateDeployedModelRequest,MutateDeployedModelResponse,MutateDeployedModelOperationMetadata> mutateDeployedModelOperationSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,EndpointServiceClient.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 EndpointServiceSettings create(EndpointServiceStubSettings 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 gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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 EndpointServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static EndpointServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public EndpointServiceSettings.Builder toBuilder()

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

Specified by:

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