com.google.cloud.aiplatform.v1beta1

Class ExampleStoreServiceSettings

java.lang.Object

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

com.google.cloud.aiplatform.v1beta1.ExampleStoreServiceSettings

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

Settings class to configure an instance of ExampleStoreServiceClient.

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

 // 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
 ExampleStoreServiceSettings.Builder exampleStoreServiceSettingsBuilder =
     ExampleStoreServiceSettings.newBuilder();
 exampleStoreServiceSettingsBuilder
     .getExampleStoreSettings()
     .setRetrySettings(
         exampleStoreServiceSettingsBuilder
             .getExampleStoreSettings()
             .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());
 ExampleStoreServiceSettings exampleStoreServiceSettings =
     exampleStoreServiceSettingsBuilder.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 createExampleStore:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ExampleStoreServiceSettings	create(ExampleStoreServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateExampleStoreRequest,ExampleStore,CreateExampleStoreOperationMetadata>	createExampleStoreOperationSettings() Returns the object with the settings used for calls to createExampleStore.
com.google.api.gax.rpc.UnaryCallSettings<CreateExampleStoreRequest,com.google.longrunning.Operation>	createExampleStoreSettings() Returns the object with the settings used for calls to createExampleStore.
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<DeleteExampleStoreRequest,com.google.protobuf.Empty,DeleteExampleStoreOperationMetadata>	deleteExampleStoreOperationSettings() Returns the object with the settings used for calls to deleteExampleStore.
com.google.api.gax.rpc.UnaryCallSettings<DeleteExampleStoreRequest,com.google.longrunning.Operation>	deleteExampleStoreSettings() Returns the object with the settings used for calls to deleteExampleStore.
com.google.api.gax.rpc.PagedCallSettings<FetchExamplesRequest,FetchExamplesResponse,ExampleStoreServiceClient.FetchExamplesPagedResponse>	fetchExamplesSettings() Returns the object with the settings used for calls to fetchExamples.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetExampleStoreRequest,ExampleStore>	getExampleStoreSettings() Returns the object with the settings used for calls to getExampleStore.
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<ListExampleStoresRequest,ListExampleStoresResponse,ExampleStoreServiceClient.ListExampleStoresPagedResponse>	listExampleStoresSettings() Returns the object with the settings used for calls to listExampleStores.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ExampleStoreServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
static ExampleStoreServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static ExampleStoreServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<RemoveExamplesRequest,RemoveExamplesResponse>	removeExamplesSettings() Returns the object with the settings used for calls to removeExamples.
com.google.api.gax.rpc.UnaryCallSettings<SearchExamplesRequest,SearchExamplesResponse>	searchExamplesSettings() Returns the object with the settings used for calls to searchExamples.
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.
ExampleStoreServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateExampleStoreRequest,ExampleStore,UpdateExampleStoreOperationMetadata>	updateExampleStoreOperationSettings() Returns the object with the settings used for calls to updateExampleStore.
com.google.api.gax.rpc.UnaryCallSettings<UpdateExampleStoreRequest,com.google.longrunning.Operation>	updateExampleStoreSettings() Returns the object with the settings used for calls to updateExampleStore.
com.google.api.gax.rpc.UnaryCallSettings<UpsertExamplesRequest,UpsertExamplesResponse>	upsertExamplesSettings() Returns the object with the settings used for calls to upsertExamples.

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

ExampleStoreServiceSettings

protected ExampleStoreServiceSettings(ExampleStoreServiceSettings.Builder settingsBuilder)
                               throws IOException

Throws:

IOException

Method Detail

createExampleStoreSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateExampleStoreRequest,com.google.longrunning.Operation> createExampleStoreSettings()

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

createExampleStoreOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateExampleStoreRequest,ExampleStore,CreateExampleStoreOperationMetadata> createExampleStoreOperationSettings()

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

getExampleStoreSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetExampleStoreRequest,ExampleStore> getExampleStoreSettings()

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

updateExampleStoreSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateExampleStoreRequest,com.google.longrunning.Operation> updateExampleStoreSettings()

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

updateExampleStoreOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateExampleStoreRequest,ExampleStore,UpdateExampleStoreOperationMetadata> updateExampleStoreOperationSettings()

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

deleteExampleStoreSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteExampleStoreRequest,com.google.longrunning.Operation> deleteExampleStoreSettings()

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

deleteExampleStoreOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteExampleStoreRequest,com.google.protobuf.Empty,DeleteExampleStoreOperationMetadata> deleteExampleStoreOperationSettings()

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

listExampleStoresSettings

public com.google.api.gax.rpc.PagedCallSettings<ListExampleStoresRequest,ListExampleStoresResponse,ExampleStoreServiceClient.ListExampleStoresPagedResponse> listExampleStoresSettings()

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

upsertExamplesSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpsertExamplesRequest,UpsertExamplesResponse> upsertExamplesSettings()

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

removeExamplesSettings

public com.google.api.gax.rpc.UnaryCallSettings<RemoveExamplesRequest,RemoveExamplesResponse> removeExamplesSettings()

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

searchExamplesSettings

public com.google.api.gax.rpc.UnaryCallSettings<SearchExamplesRequest,SearchExamplesResponse> searchExamplesSettings()

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

fetchExamplesSettings

public com.google.api.gax.rpc.PagedCallSettings<FetchExamplesRequest,FetchExamplesResponse,ExampleStoreServiceClient.FetchExamplesPagedResponse> fetchExamplesSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ExampleStoreServiceClient.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 ExampleStoreServiceSettings create(ExampleStoreServiceStubSettings 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 ExampleStoreServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public ExampleStoreServiceSettings.Builder toBuilder()

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

Specified by:

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