com.google.cloud.pubsublite.v1.stub

Class CursorServiceStubSettings

java.lang.Object

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

com.google.cloud.pubsublite.v1.stub.CursorServiceStubSettings

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

Settings class to configure an instance of CursorServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (pubsublite.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 commitCursor to 30 seconds:

 // 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
 CursorServiceStubSettings.Builder cursorServiceSettingsBuilder =
     CursorServiceStubSettings.newBuilder();
 cursorServiceSettingsBuilder
     .commitCursorSettings()
     .setRetrySettings(
         cursorServiceSettingsBuilder
             .commitCursorSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CursorServiceStubSettings cursorServiceSettings = cursorServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<CommitCursorRequest,CommitCursorResponse>	commitCursorSettings() Returns the object with the settings used for calls to commitCursor.
CursorServiceStub	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()
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.PagedCallSettings<ListPartitionCursorsRequest,ListPartitionCursorsResponse,CursorServiceClient.ListPartitionCursorsPagedResponse>	listPartitionCursorsSettings() Returns the object with the settings used for calls to listPartitionCursors.
static CursorServiceStubSettings.Builder	newBuilder() Returns a new builder for this class.
static CursorServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.StreamingCallSettings<StreamingCommitCursorRequest,StreamingCommitCursorResponse>	streamingCommitCursorSettings() Returns the object with the settings used for calls to streamingCommitCursor.
CursorServiceStubSettings.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

CursorServiceStubSettings

protected CursorServiceStubSettings(CursorServiceStubSettings.Builder settingsBuilder)
                             throws IOException

Throws:

IOException

Method Detail

streamingCommitCursorSettings

public com.google.api.gax.rpc.StreamingCallSettings<StreamingCommitCursorRequest,StreamingCommitCursorResponse> streamingCommitCursorSettings()

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

commitCursorSettings

public com.google.api.gax.rpc.UnaryCallSettings<CommitCursorRequest,CommitCursorResponse> commitCursorSettings()

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

listPartitionCursorsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListPartitionCursorsRequest,ListPartitionCursorsResponse,CursorServiceClient.ListPartitionCursorsPagedResponse> listPartitionCursorsSettings()

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

createStub

public CursorServiceStub 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.

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

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static CursorServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public CursorServiceStubSettings.Builder toBuilder()

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

Specified by:

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