Class ExtensionExecutionServiceSettings (3.52.0)

public class ExtensionExecutionServiceSettings extends ClientSettings<ExtensionExecutionServiceSettings>

Settings class to configure an instance of ExtensionExecutionServiceClient.

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


 // 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
 ExtensionExecutionServiceSettings.Builder extensionExecutionServiceSettingsBuilder =
     ExtensionExecutionServiceSettings.newBuilder();
 extensionExecutionServiceSettingsBuilder
     .executeExtensionSettings()
     .setRetrySettings(
         extensionExecutionServiceSettingsBuilder
             .executeExtensionSettings()
             .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());
 ExtensionExecutionServiceSettings extensionExecutionServiceSettings =
     extensionExecutionServiceSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > ClientSettings > ExtensionExecutionServiceSettings

Static Methods

create(ExtensionExecutionServiceStubSettings stub)

public static final ExtensionExecutionServiceSettings create(ExtensionExecutionServiceStubSettings stub)
Parameter
Name Description
stub ExtensionExecutionServiceStubSettings
Returns
Type Description
ExtensionExecutionServiceSettings
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 ExtensionExecutionServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
ExtensionExecutionServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static ExtensionExecutionServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ExtensionExecutionServiceSettings.Builder

Constructors

ExtensionExecutionServiceSettings(ExtensionExecutionServiceSettings.Builder settingsBuilder)

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

Methods

executeExtensionSettings()

public UnaryCallSettings<ExecuteExtensionRequest,ExecuteExtensionResponse> executeExtensionSettings()

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

Returns
Type Description
UnaryCallSettings<ExecuteExtensionRequest,ExecuteExtensionResponse>

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>

listLocationsSettings()

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

queryExtensionSettings()

public UnaryCallSettings<QueryExtensionRequest,QueryExtensionResponse> queryExtensionSettings()

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

Returns
Type Description
UnaryCallSettings<QueryExtensionRequest,QueryExtensionResponse>

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 ExtensionExecutionServiceSettings.Builder toBuilder()

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

Returns
Type Description
ExtensionExecutionServiceSettings.Builder
Overrides