Class SlateServiceStubSettings (0.54.0) 

public class SlateServiceStubSettings extends StubSettings<SlateServiceStubSettings>

Settings class to configure an instance of SlateServiceStub.

The default instance has everything set to sensible defaults:

  • The default service address (admanager.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 of getSlate:


 // 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
 SlateServiceStubSettings.Builder slateServiceSettingsBuilder =
     SlateServiceStubSettings.newBuilder();
 slateServiceSettingsBuilder
     .getSlateSettings()
     .setRetrySettings(
         slateServiceSettingsBuilder
             .getSlateSettings()
             .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());
 SlateServiceStubSettings slateServiceSettings = slateServiceSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > StubSettings > SlateServiceStubSettings

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

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns a new builder for this class.

Returns
Type Description
SlateServiceStubSettings.Builder

newBuilder(@Nullable ClientContext clientContext)

public static SlateServiceStubSettings.Builder newBuilder(@Nullable ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext @org.jspecify.annotations.Nullable com.google.api.gax.rpc.ClientContext
Returns
Type Description
SlateServiceStubSettings.Builder

Constructors

SlateServiceStubSettings(SlateServiceStubSettings.Builder settingsBuilder)

protected SlateServiceStubSettings(SlateServiceStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder SlateServiceStubSettings.Builder

Methods

batchArchiveSlatesSettings()

public UnaryCallSettings<BatchArchiveSlatesRequest,BatchArchiveSlatesResponse> batchArchiveSlatesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchArchiveSlatesRequest,BatchArchiveSlatesResponse>

batchCreateSlatesSettings()

public UnaryCallSettings<BatchCreateSlatesRequest,BatchCreateSlatesResponse> batchCreateSlatesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchCreateSlatesRequest,BatchCreateSlatesResponse>

batchUnarchiveSlatesSettings()

public UnaryCallSettings<BatchUnarchiveSlatesRequest,BatchUnarchiveSlatesResponse> batchUnarchiveSlatesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchUnarchiveSlatesRequest,BatchUnarchiveSlatesResponse>

batchUpdateSlatesSettings()

public UnaryCallSettings<BatchUpdateSlatesRequest,BatchUpdateSlatesResponse> batchUpdateSlatesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchUpdateSlatesRequest,BatchUpdateSlatesResponse>

createSlateSettings()

public UnaryCallSettings<CreateSlateRequest,Slate> createSlateSettings()

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

Returns
Type Description
UnaryCallSettings<CreateSlateRequest,Slate>

createStub()

public SlateServiceStub createStub()
Returns
Type Description
SlateServiceStub
Exceptions
Type Description
IOException

getLibraryMetadata()

protected LibraryMetadata getLibraryMetadata()
Returns
Type Description
LibraryMetadata
Overrides

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getSlateSettings()

public UnaryCallSettings<GetSlateRequest,Slate> getSlateSettings()

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

Returns
Type Description
UnaryCallSettings<GetSlateRequest,Slate>

listSlatesSettings()

public PagedCallSettings<ListSlatesRequest,ListSlatesResponse,SlateServiceClient.ListSlatesPagedResponse> listSlatesSettings()

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

Returns
Type Description
PagedCallSettings<ListSlatesRequest,ListSlatesResponse,ListSlatesPagedResponse>

toBuilder()

public SlateServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
SlateServiceStubSettings.Builder
Overrides

updateSlateSettings()

public UnaryCallSettings<UpdateSlateRequest,Slate> updateSlateSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateSlateRequest,Slate>