Class YieldGroupServiceStubSettings (0.62.0)

public class YieldGroupServiceStubSettings extends StubSettings<YieldGroupServiceStubSettings>

Settings class to configure an instance of YieldGroupServiceStub.

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 getYieldGroup:


 // 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
 YieldGroupServiceStubSettings.Builder yieldGroupServiceSettingsBuilder =
     YieldGroupServiceStubSettings.newBuilder();
 yieldGroupServiceSettingsBuilder
     .getYieldGroupSettings()
     .setRetrySettings(
         yieldGroupServiceSettingsBuilder
             .getYieldGroupSettings()
             .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());
 YieldGroupServiceStubSettings yieldGroupServiceSettings =
     yieldGroupServiceSettingsBuilder.build();
 

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

Inheritance

java.lang.Object > StubSettings > YieldGroupServiceStubSettings

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

Returns a new builder for this class.

Returns
Type Description
YieldGroupServiceStubSettings.Builder

newBuilder(@Nullable ClientContext clientContext)

public static YieldGroupServiceStubSettings.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
YieldGroupServiceStubSettings.Builder

Constructors

YieldGroupServiceStubSettings(YieldGroupServiceStubSettings.Builder settingsBuilder)

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

Methods

batchActivateYieldGroupsSettings()

public UnaryCallSettings<BatchActivateYieldGroupsRequest,BatchActivateYieldGroupsResponse> batchActivateYieldGroupsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchActivateYieldGroupsRequest,BatchActivateYieldGroupsResponse>

batchArchiveYieldGroupsSettings()

public UnaryCallSettings<BatchArchiveYieldGroupsRequest,BatchArchiveYieldGroupsResponse> batchArchiveYieldGroupsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchArchiveYieldGroupsRequest,BatchArchiveYieldGroupsResponse>

batchCreateYieldGroupsSettings()

public UnaryCallSettings<BatchCreateYieldGroupsRequest,BatchCreateYieldGroupsResponse> batchCreateYieldGroupsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchCreateYieldGroupsRequest,BatchCreateYieldGroupsResponse>

batchDeactivateYieldGroupsSettings()

public UnaryCallSettings<BatchDeactivateYieldGroupsRequest,BatchDeactivateYieldGroupsResponse> batchDeactivateYieldGroupsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchDeactivateYieldGroupsRequest,BatchDeactivateYieldGroupsResponse>

batchUpdateYieldGroupsSettings()

public UnaryCallSettings<BatchUpdateYieldGroupsRequest,BatchUpdateYieldGroupsResponse> batchUpdateYieldGroupsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchUpdateYieldGroupsRequest,BatchUpdateYieldGroupsResponse>

createStub()

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

createYieldGroupSettings()

public UnaryCallSettings<CreateYieldGroupRequest,YieldGroup> createYieldGroupSettings()

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

Returns
Type Description
UnaryCallSettings<CreateYieldGroupRequest,YieldGroup>

getLibraryMetadata()

protected LibraryMetadata getLibraryMetadata()
Returns
Type Description
LibraryMetadata
Overrides

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getYieldGroupSettings()

public UnaryCallSettings<GetYieldGroupRequest,YieldGroup> getYieldGroupSettings()

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

Returns
Type Description
UnaryCallSettings<GetYieldGroupRequest,YieldGroup>

listYieldGroupsSettings()

public PagedCallSettings<ListYieldGroupsRequest,ListYieldGroupsResponse,YieldGroupServiceClient.ListYieldGroupsPagedResponse> listYieldGroupsSettings()

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

Returns
Type Description
PagedCallSettings<ListYieldGroupsRequest,ListYieldGroupsResponse,ListYieldGroupsPagedResponse>

toBuilder()

public YieldGroupServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
YieldGroupServiceStubSettings.Builder
Overrides

updateYieldGroupSettings()

public UnaryCallSettings<UpdateYieldGroupRequest,YieldGroup> updateYieldGroupSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateYieldGroupRequest,YieldGroup>