Class EndpointServiceSettings (1.40.0)

publicclass EndpointServiceSettingsextendsClientSettings<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 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.BuilderendpointServiceSettingsBuilder=
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());
EndpointServiceSettingsendpointServiceSettings=endpointServiceSettingsBuilder.build();

Please refer to the Client Side Retry Guide 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.BuilderendpointServiceSettingsBuilder=
EndpointServiceSettings.newBuilder();
TimedRetryAlgorithmtimedRetryAlgorithm=
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();

Inheritance

java.lang.Object > ClientSettings > EndpointServiceSettings

Inherited Members

Static Methods

create(EndpointServiceStubSettings stub)

publicstaticfinalEndpointServiceSettingscreate(EndpointServiceStubSettingsstub)
Parameter
Name Description
stub EndpointServiceStubSettings
Returns
Type Description
EndpointServiceSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

publicstaticTransportChannelProviderdefaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

publicstaticStringgetDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

publicstaticList<String>getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

publicstaticEndpointServiceSettings.BuildernewBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
EndpointServiceSettings.Builder

newBuilder(ClientContext clientContext)

publicstaticEndpointServiceSettings.BuildernewBuilder(ClientContextclientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
EndpointServiceSettings.Builder

newHttpJsonBuilder()

publicstaticEndpointServiceSettings.BuildernewHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
EndpointServiceSettings.Builder

Constructors

EndpointServiceSettings(EndpointServiceSettings.Builder settingsBuilder)

protectedEndpointServiceSettings(EndpointServiceSettings.BuildersettingsBuilder)
Parameter
Name Description
settingsBuilder EndpointServiceSettings.Builder

Methods

createEndpointOperationSettings()

publicOperationCallSettings<CreateEndpointRequest,Endpoint,CreateEndpointOperationMetadata>createEndpointOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateEndpointRequest,Endpoint,CreateEndpointOperationMetadata>

createEndpointSettings()

publicUnaryCallSettings<CreateEndpointRequest,Operation>createEndpointSettings()

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

Returns
Type Description
UnaryCallSettings<CreateEndpointRequest,Operation>

deleteEndpointOperationSettings()

publicOperationCallSettings<DeleteEndpointRequest,Empty,DeleteOperationMetadata>deleteEndpointOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteEndpointRequest,Empty,DeleteOperationMetadata>

deleteEndpointSettings()

publicUnaryCallSettings<DeleteEndpointRequest,Operation>deleteEndpointSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteEndpointRequest,Operation>

deployModelOperationSettings()

publicOperationCallSettings<DeployModelRequest,DeployModelResponse,DeployModelOperationMetadata>deployModelOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeployModelRequest,DeployModelResponse,DeployModelOperationMetadata>

deployModelSettings()

publicUnaryCallSettings<DeployModelRequest,Operation>deployModelSettings()

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

Returns
Type Description
UnaryCallSettings<DeployModelRequest,Operation>

getEndpointSettings()

publicUnaryCallSettings<GetEndpointRequest,Endpoint>getEndpointSettings()

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

Returns
Type Description
UnaryCallSettings<GetEndpointRequest,Endpoint>

getIamPolicySettings()

publicUnaryCallSettings<GetIamPolicyRequest,Policy>getIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocationSettings()

publicUnaryCallSettings<GetLocationRequest,Location>getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

listEndpointsSettings()

publicPagedCallSettings<ListEndpointsRequest,ListEndpointsResponse,EndpointServiceClient.ListEndpointsPagedResponse>listEndpointsSettings()

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

Returns
Type Description
PagedCallSettings<ListEndpointsRequest,ListEndpointsResponse,ListEndpointsPagedResponse>

listLocationsSettings()

publicPagedCallSettings<ListLocationsRequest,ListLocationsResponse,EndpointServiceClient.ListLocationsPagedResponse>listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

mutateDeployedModelOperationSettings()

publicOperationCallSettings<MutateDeployedModelRequest,MutateDeployedModelResponse,MutateDeployedModelOperationMetadata>mutateDeployedModelOperationSettings()

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

Returns
Type Description
OperationCallSettings<MutateDeployedModelRequest,MutateDeployedModelResponse,MutateDeployedModelOperationMetadata>

mutateDeployedModelSettings()

publicUnaryCallSettings<MutateDeployedModelRequest,Operation>mutateDeployedModelSettings()

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

Returns
Type Description
UnaryCallSettings<MutateDeployedModelRequest,Operation>

setIamPolicySettings()

publicUnaryCallSettings<SetIamPolicyRequest,Policy>setIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

publicUnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse>testIamPermissionsSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

publicEndpointServiceSettings.BuildertoBuilder()

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

Returns
Type Description
EndpointServiceSettings.Builder
Overrides

undeployModelOperationSettings()

publicOperationCallSettings<UndeployModelRequest,UndeployModelResponse,UndeployModelOperationMetadata>undeployModelOperationSettings()

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

Returns
Type Description
OperationCallSettings<UndeployModelRequest,UndeployModelResponse,UndeployModelOperationMetadata>

undeployModelSettings()

publicUnaryCallSettings<UndeployModelRequest,Operation>undeployModelSettings()

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

Returns
Type Description
UnaryCallSettings<UndeployModelRequest,Operation>

updateEndpointLongRunningOperationSettings()

publicOperationCallSettings<UpdateEndpointLongRunningRequest,Endpoint,UpdateEndpointOperationMetadata>updateEndpointLongRunningOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateEndpointLongRunningRequest,Endpoint,UpdateEndpointOperationMetadata>

updateEndpointLongRunningSettings()

publicUnaryCallSettings<UpdateEndpointLongRunningRequest,Operation>updateEndpointLongRunningSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateEndpointLongRunningRequest,Operation>

updateEndpointSettings()

publicUnaryCallSettings<UpdateEndpointRequest,Endpoint>updateEndpointSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateEndpointRequest,Endpoint>

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.