com.google.cloud.aiplatform.v1beta1.stub

Class MemoryBankServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<MemoryBankServiceStubSettings>

com.google.cloud.aiplatform.v1beta1.stub.MemoryBankServiceStubSettings

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

Settings class to configure an instance of MemoryBankServiceStub.

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

 // 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
 MemoryBankServiceStubSettings.Builder memoryBankServiceSettingsBuilder =
     MemoryBankServiceStubSettings.newBuilder();
 memoryBankServiceSettingsBuilder
     .getMemorySettings()
     .setRetrySettings(
         memoryBankServiceSettingsBuilder
             .getMemorySettings()
             .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());
 MemoryBankServiceStubSettings memoryBankServiceSettings =
     memoryBankServiceSettingsBuilder.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 createMemory:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<CreateMemoryRequest,Memory,CreateMemoryOperationMetadata>	createMemoryOperationSettings() Returns the object with the settings used for calls to createMemory.
com.google.api.gax.rpc.UnaryCallSettings<CreateMemoryRequest,com.google.longrunning.Operation>	createMemorySettings() Returns the object with the settings used for calls to createMemory.
MemoryBankServiceStub	createStub()
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<DeleteMemoryRequest,com.google.protobuf.Empty,DeleteMemoryOperationMetadata>	deleteMemoryOperationSettings() Returns the object with the settings used for calls to deleteMemory.
com.google.api.gax.rpc.UnaryCallSettings<DeleteMemoryRequest,com.google.longrunning.Operation>	deleteMemorySettings() Returns the object with the settings used for calls to deleteMemory.
com.google.api.gax.rpc.OperationCallSettings<GenerateMemoriesRequest,GenerateMemoriesResponse,GenerateMemoriesOperationMetadata>	generateMemoriesOperationSettings() Returns the object with the settings used for calls to generateMemories.
com.google.api.gax.rpc.UnaryCallSettings<GenerateMemoriesRequest,com.google.longrunning.Operation>	generateMemoriesSettings() Returns the object with the settings used for calls to generateMemories.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
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.UnaryCallSettings<GetMemoryRequest,Memory>	getMemorySettings() Returns the object with the settings used for calls to getMemory.
String	getServiceName() Returns the default service name.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,MemoryBankServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.PagedCallSettings<ListMemoriesRequest,ListMemoriesResponse,MemoryBankServiceClient.ListMemoriesPagedResponse>	listMemoriesSettings() Returns the object with the settings used for calls to listMemories.
static MemoryBankServiceStubSettings.Builder	newBuilder() Returns a new builder for this class.
static MemoryBankServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<RetrieveMemoriesRequest,RetrieveMemoriesResponse>	retrieveMemoriesSettings() Returns the object with the settings used for calls to retrieveMemories.
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.
MemoryBankServiceStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateMemoryRequest,Memory,UpdateMemoryOperationMetadata>	updateMemoryOperationSettings() Returns the object with the settings used for calls to updateMemory.
com.google.api.gax.rpc.UnaryCallSettings<UpdateMemoryRequest,com.google.longrunning.Operation>	updateMemorySettings() Returns the object with the settings used for calls to updateMemory.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MemoryBankServiceStubSettings

protected MemoryBankServiceStubSettings(MemoryBankServiceStubSettings.Builder settingsBuilder)
                                 throws IOException

Throws:

IOException

Method Detail

createMemorySettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateMemoryRequest,com.google.longrunning.Operation> createMemorySettings()

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

createMemoryOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateMemoryRequest,Memory,CreateMemoryOperationMetadata> createMemoryOperationSettings()

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

getMemorySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetMemoryRequest,Memory> getMemorySettings()

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

updateMemorySettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateMemoryRequest,com.google.longrunning.Operation> updateMemorySettings()

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

updateMemoryOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateMemoryRequest,Memory,UpdateMemoryOperationMetadata> updateMemoryOperationSettings()

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

listMemoriesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListMemoriesRequest,ListMemoriesResponse,MemoryBankServiceClient.ListMemoriesPagedResponse> listMemoriesSettings()

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

deleteMemorySettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteMemoryRequest,com.google.longrunning.Operation> deleteMemorySettings()

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

deleteMemoryOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteMemoryRequest,com.google.protobuf.Empty,DeleteMemoryOperationMetadata> deleteMemoryOperationSettings()

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

generateMemoriesSettings

public com.google.api.gax.rpc.UnaryCallSettings<GenerateMemoriesRequest,com.google.longrunning.Operation> generateMemoriesSettings()

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

generateMemoriesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<GenerateMemoriesRequest,GenerateMemoriesResponse,GenerateMemoriesOperationMetadata> generateMemoriesOperationSettings()

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

retrieveMemoriesSettings

public com.google.api.gax.rpc.UnaryCallSettings<RetrieveMemoriesRequest,RetrieveMemoriesResponse> retrieveMemoriesSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,MemoryBankServiceClient.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.

createStub

public MemoryBankServiceStub createStub()
                                 throws IOException

Throws:

IOException

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<MemoryBankServiceStubSettings>

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

@ObsoleteApi(value="Use getEndpoint() instead")
public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 MemoryBankServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public MemoryBankServiceStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<MemoryBankServiceStubSettings>