com.google.api.gax.httpjson.longrunning.stub

Class OperationsStubSettings

java.lang.Object

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

com.google.api.gax.httpjson.longrunning.stub.OperationsStubSettings

public class OperationsStubSettings
extends com.google.api.gax.rpc.StubSettings<OperationsStubSettings>

Settings class to configure an instance of OperationsStub.

The default instance has everything set to sensible defaults:

• The default service address (longrunning.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 total timeout of getOperation to 30 seconds:

 OperationsStubSettings.Builder operationsSettingsBuilder = OperationsStubSettings.newBuilder();
 operationsSettingsBuilder
     .getOperationSettings()
     .setRetrySettings(
         operationsSettingsBuilder
             .getOperationSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OperationsStubSettings operationsSettings = operationsSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<com.google.longrunning.CancelOperationRequest,com.google.protobuf.Empty>	cancelOperationSettings() Returns the object with the settings used for calls to cancel.
OperationsStub	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 InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<com.google.longrunning.DeleteOperationRequest,com.google.protobuf.Empty>	deleteOperationSettings() Returns the object with the settings used for calls to delete.
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.longrunning.GetOperationRequest,com.google.longrunning.Operation>	getOperationSettings() Returns the object with the settings used for calls to get.
com.google.api.gax.rpc.PagedCallSettings<com.google.longrunning.ListOperationsRequest,com.google.longrunning.ListOperationsResponse,OperationsClient.ListOperationsPagedResponse>	listOperationsSettings() Returns the object with the settings used for calls to listOperations.
static OperationsStubSettings.Builder	newBuilder() Returns a new builder for this class.
static OperationsStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
OperationsStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationsStubSettings

protected OperationsStubSettings(OperationsStubSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

listOperationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.longrunning.ListOperationsRequest,com.google.longrunning.ListOperationsResponse,OperationsClient.ListOperationsPagedResponse> listOperationsSettings()

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

getOperationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.longrunning.GetOperationRequest,com.google.longrunning.Operation> getOperationSettings()

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

deleteOperationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.longrunning.DeleteOperationRequest,com.google.protobuf.Empty> deleteOperationSettings()

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

cancelOperationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.longrunning.CancelOperationRequest,com.google.protobuf.Empty> cancelOperationSettings()

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

createStub

public OperationsStub createStub()
                          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.

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.

defaultHttpJsonTransportProviderBuilder

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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 OperationsStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public OperationsStubSettings.Builder toBuilder()

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

Specified by:

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