com.google.cloud.aiplatform.v1beta1

Class SessionServiceSettings

java.lang.Object

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

com.google.cloud.aiplatform.v1beta1.SessionServiceSettings

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

Settings class to configure an instance of SessionServiceClient.

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

 // 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
 SessionServiceSettings.Builder sessionServiceSettingsBuilder =
     SessionServiceSettings.newBuilder();
 sessionServiceSettingsBuilder
     .getSessionSettings()
     .setRetrySettings(
         sessionServiceSettingsBuilder
             .getSessionSettings()
             .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());
 SessionServiceSettings sessionServiceSettings = sessionServiceSettingsBuilder.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 createSession:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<AppendEventRequest,AppendEventResponse>	appendEventSettings() Returns the object with the settings used for calls to appendEvent.
static SessionServiceSettings	create(SessionServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateSessionRequest,Session,CreateSessionOperationMetadata>	createSessionOperationSettings() Returns the object with the settings used for calls to createSession.
com.google.api.gax.rpc.UnaryCallSettings<CreateSessionRequest,com.google.longrunning.Operation>	createSessionSettings() Returns the object with the settings used for calls to createSession.
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<DeleteSessionRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteSessionOperationSettings() Returns the object with the settings used for calls to deleteSession.
com.google.api.gax.rpc.UnaryCallSettings<DeleteSessionRequest,com.google.longrunning.Operation>	deleteSessionSettings() Returns the object with the settings used for calls to deleteSession.
static String	getDefaultEndpoint() Returns the default 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<GetSessionRequest,Session>	getSessionSettings() Returns the object with the settings used for calls to getSession.
com.google.api.gax.rpc.PagedCallSettings<ListEventsRequest,ListEventsResponse,SessionServiceClient.ListEventsPagedResponse>	listEventsSettings() Returns the object with the settings used for calls to listEvents.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,SessionServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.PagedCallSettings<ListSessionsRequest,ListSessionsResponse,SessionServiceClient.ListSessionsPagedResponse>	listSessionsSettings() Returns the object with the settings used for calls to listSessions.
static SessionServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static SessionServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
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.
SessionServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateSessionRequest,Session>	updateSessionSettings() Returns the object with the settings used for calls to updateSession.

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

SessionServiceSettings

protected SessionServiceSettings(SessionServiceSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

createSessionSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateSessionRequest,com.google.longrunning.Operation> createSessionSettings()

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

createSessionOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateSessionRequest,Session,CreateSessionOperationMetadata> createSessionOperationSettings()

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

getSessionSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetSessionRequest,Session> getSessionSettings()

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

listSessionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListSessionsRequest,ListSessionsResponse,SessionServiceClient.ListSessionsPagedResponse> listSessionsSettings()

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

updateSessionSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateSessionRequest,Session> updateSessionSettings()

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

deleteSessionSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteSessionRequest,com.google.longrunning.Operation> deleteSessionSettings()

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

deleteSessionOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteSessionRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteSessionOperationSettings()

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

listEventsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListEventsRequest,ListEventsResponse,SessionServiceClient.ListEventsPagedResponse> listEventsSettings()

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

appendEventSettings

public com.google.api.gax.rpc.UnaryCallSettings<AppendEventRequest,AppendEventResponse> appendEventSettings()

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

listLocationsSettings

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

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public SessionServiceSettings.Builder toBuilder()

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

Specified by:

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