Class SpecialistPoolServiceSettings (3.52.0)

public class SpecialistPoolServiceSettings extends ClientSettings<SpecialistPoolServiceSettings>

Settings class to configure an instance of SpecialistPoolServiceClient.

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


 // 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
 SpecialistPoolServiceSettings.Builder specialistPoolServiceSettingsBuilder =
     SpecialistPoolServiceSettings.newBuilder();
 specialistPoolServiceSettingsBuilder
     .getSpecialistPoolSettings()
     .setRetrySettings(
         specialistPoolServiceSettingsBuilder
             .getSpecialistPoolSettings()
             .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());
 SpecialistPoolServiceSettings specialistPoolServiceSettings =
     specialistPoolServiceSettingsBuilder.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 createSpecialistPool:


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

Inheritance

java.lang.Object > ClientSettings > SpecialistPoolServiceSettings

Static Methods

create(SpecialistPoolServiceStubSettings stub)

public static final SpecialistPoolServiceSettings create(SpecialistPoolServiceStubSettings stub)
Parameter
Name Description
stub SpecialistPoolServiceStubSettings
Returns
Type Description
SpecialistPoolServiceSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static SpecialistPoolServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
SpecialistPoolServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static SpecialistPoolServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
SpecialistPoolServiceSettings.Builder

Constructors

SpecialistPoolServiceSettings(SpecialistPoolServiceSettings.Builder settingsBuilder)

protected SpecialistPoolServiceSettings(SpecialistPoolServiceSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder SpecialistPoolServiceSettings.Builder

Methods

createSpecialistPoolOperationSettings()

public OperationCallSettings<CreateSpecialistPoolRequest,SpecialistPool,CreateSpecialistPoolOperationMetadata> createSpecialistPoolOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateSpecialistPoolRequest,SpecialistPool,CreateSpecialistPoolOperationMetadata>

createSpecialistPoolSettings()

public UnaryCallSettings<CreateSpecialistPoolRequest,Operation> createSpecialistPoolSettings()

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

Returns
Type Description
UnaryCallSettings<CreateSpecialistPoolRequest,Operation>

deleteSpecialistPoolOperationSettings()

public OperationCallSettings<DeleteSpecialistPoolRequest,Empty,DeleteOperationMetadata> deleteSpecialistPoolOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteSpecialistPoolRequest,Empty,DeleteOperationMetadata>

deleteSpecialistPoolSettings()

public UnaryCallSettings<DeleteSpecialistPoolRequest,Operation> deleteSpecialistPoolSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteSpecialistPoolRequest,Operation>

getIamPolicySettings()

public UnaryCallSettings<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()

public UnaryCallSettings<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>

getSpecialistPoolSettings()

public UnaryCallSettings<GetSpecialistPoolRequest,SpecialistPool> getSpecialistPoolSettings()

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

Returns
Type Description
UnaryCallSettings<GetSpecialistPoolRequest,SpecialistPool>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,SpecialistPoolServiceClient.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>

listSpecialistPoolsSettings()

public PagedCallSettings<ListSpecialistPoolsRequest,ListSpecialistPoolsResponse,SpecialistPoolServiceClient.ListSpecialistPoolsPagedResponse> listSpecialistPoolsSettings()

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

Returns
Type Description
PagedCallSettings<ListSpecialistPoolsRequest,ListSpecialistPoolsResponse,ListSpecialistPoolsPagedResponse>

setIamPolicySettings()

public UnaryCallSettings<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()

public UnaryCallSettings<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()

public SpecialistPoolServiceSettings.Builder toBuilder()

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

Returns
Type Description
SpecialistPoolServiceSettings.Builder
Overrides

updateSpecialistPoolOperationSettings()

public OperationCallSettings<UpdateSpecialistPoolRequest,SpecialistPool,UpdateSpecialistPoolOperationMetadata> updateSpecialistPoolOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateSpecialistPoolRequest,SpecialistPool,UpdateSpecialistPoolOperationMetadata>

updateSpecialistPoolSettings()

public UnaryCallSettings<UpdateSpecialistPoolRequest,Operation> updateSpecialistPoolSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateSpecialistPoolRequest,Operation>