Class SessionServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<SessionServiceSettings>
com.google.cloud.aiplatform.v1beta1.SessionServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class SessionServiceSettings
extends 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://docs.cloud.google.com/java/docs/client-retries) 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 ClassesModifier and TypeClassDescriptionstatic classBuilder for SessionServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedSessionServiceSettings(SessionServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to appendEvent.static final SessionServiceSettingsReturns the object with the settings used for calls to createSession.Returns the object with the settings used for calls to createSession.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteSessionRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteSession.Returns the object with the settings used for calls to deleteSession.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getSession.PagedCallSettings<ListEventsRequest,ListEventsResponse, SessionServiceClient.ListEventsPagedResponse> Returns the object with the settings used for calls to listEvents.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, SessionServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListSessionsRequest,ListSessionsResponse, SessionServiceClient.ListSessionsPagedResponse> Returns the object with the settings used for calls to listSessions.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.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
-
Constructor Details
-
SessionServiceSettings
- Throws:
IOException
-
-
Method Details
-
createSessionSettings
Returns the object with the settings used for calls to createSession. -
createSessionOperationSettings
public OperationCallSettings<CreateSessionRequest,Session, createSessionOperationSettings()CreateSessionOperationMetadata> Returns the object with the settings used for calls to createSession. -
getSessionSettings
Returns the object with the settings used for calls to getSession. -
listSessionsSettings
public PagedCallSettings<ListSessionsRequest,ListSessionsResponse, listSessionsSettings()SessionServiceClient.ListSessionsPagedResponse> Returns the object with the settings used for calls to listSessions. -
updateSessionSettings
Returns the object with the settings used for calls to updateSession. -
deleteSessionSettings
Returns the object with the settings used for calls to deleteSession. -
deleteSessionOperationSettings
public OperationCallSettings<DeleteSessionRequest,com.google.protobuf.Empty, deleteSessionOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteSession. -
listEventsSettings
public PagedCallSettings<ListEventsRequest,ListEventsResponse, listEventsSettings()SessionServiceClient.ListEventsPagedResponse> Returns the object with the settings used for calls to listEvents. -
appendEventSettings
Returns the object with the settings used for calls to appendEvent. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()SessionServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,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
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<SessionServiceSettings>
-