Class CursorServiceStubSettings (1.4.12)

public class CursorServiceStubSettings extends 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:


 CursorServiceStubSettings.Builder cursorServiceSettingsBuilder =
     CursorServiceStubSettings.newBuilder();
 cursorServiceSettingsBuilder
     .commitCursorSettings()
     .setRetrySettings(
         cursorServiceSettingsBuilder
             .commitCursorSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CursorServiceStubSettings cursorServiceSettings = cursorServiceSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > CursorServiceStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns

Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static CursorServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
CursorServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CursorServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
CursorServiceStubSettings.Builder

Constructors

CursorServiceStubSettings(CursorServiceStubSettings.Builder settingsBuilder)

protected CursorServiceStubSettings(CursorServiceStubSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`CursorServiceStubSettings.Builder`

Methods

commitCursorSettings()

public UnaryCallSettings<CommitCursorRequest,CommitCursorResponse> commitCursorSettings()

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

Returns

Type	Description
UnaryCallSettings<CommitCursorRequest,CommitCursorResponse>

createStub()

public CursorServiceStub createStub()

Returns

Type	Description
CursorServiceStub

Exceptions

Type	Description
IOException

listPartitionCursorsSettings()

public PagedCallSettings<ListPartitionCursorsRequest,ListPartitionCursorsResponse,CursorServiceClient.ListPartitionCursorsPagedResponse> listPartitionCursorsSettings()

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

Returns

Type	Description
PagedCallSettings<ListPartitionCursorsRequest,ListPartitionCursorsResponse,ListPartitionCursorsPagedResponse>

streamingCommitCursorSettings()

public StreamingCallSettings<StreamingCommitCursorRequest,StreamingCommitCursorResponse> streamingCommitCursorSettings()

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

Returns

Type	Description
StreamingCallSettings<StreamingCommitCursorRequest,StreamingCommitCursorResponse>

toBuilder()

public CursorServiceStubSettings.Builder toBuilder()

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

Returns

Type	Description
CursorServiceStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()