Class CursorServiceSettings (1.7.1)

public class CursorServiceSettings extends ClientSettings<CursorServiceSettings>

Settings class to configure an instance of CursorServiceClient.

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

Inheritance

java.lang.Object > ClientSettings > CursorServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.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

create(CursorServiceStubSettings stub)

public static final CursorServiceSettings create(CursorServiceStubSettings stub)

Parameter

Name	Description
stub	`CursorServiceStubSettings`

Returns

Type	Description
CursorServiceSettings

Exceptions

Type	Description
IOException

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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static CursorServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
CursorServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static CursorServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
CursorServiceSettings.Builder

Constructors

CursorServiceSettings(CursorServiceSettings.Builder settingsBuilder)

protected CursorServiceSettings(CursorServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`CursorServiceSettings.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>

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 CursorServiceSettings.Builder toBuilder()

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

Returns

Type	Description
CursorServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()