Class ControlServiceStubSettings (2.2.3) 

public class ControlServiceStubSettings extends StubSettings<ControlServiceStubSettings>

Settings class to configure an instance of ControlServiceStub.

The default instance has everything set to sensible defaults:

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


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ControlServiceStubSettings.Builder controlServiceSettingsBuilder =
     ControlServiceStubSettings.newBuilder();
 controlServiceSettingsBuilder
     .createControlSettings()
     .setRetrySettings(
         controlServiceSettingsBuilder
             .createControlSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ControlServiceStubSettings controlServiceSettings = controlServiceSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > ControlServiceStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static ControlServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
ControlServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static ControlServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
ControlServiceStubSettings.Builder

Constructors

ControlServiceStubSettings(ControlServiceStubSettings.Builder settingsBuilder)

protected ControlServiceStubSettings(ControlServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderControlServiceStubSettings.Builder

Methods

createControlSettings()

public UnaryCallSettings<CreateControlRequest,Control> createControlSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateControlRequest,Control>

createStub()

public ControlServiceStub createStub()
Returns
TypeDescription
ControlServiceStub
Exceptions
TypeDescription
IOException

deleteControlSettings()

public UnaryCallSettings<DeleteControlRequest,Empty> deleteControlSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteControlRequest,Empty>

getControlSettings()

public UnaryCallSettings<GetControlRequest,Control> getControlSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetControlRequest,Control>

listControlsSettings()

public PagedCallSettings<ListControlsRequest,ListControlsResponse,ControlServiceClient.ListControlsPagedResponse> listControlsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListControlsRequest,ListControlsResponse,ListControlsPagedResponse>

toBuilder()

public ControlServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
ControlServiceStubSettings.Builder
Overrides

updateControlSettings()

public UnaryCallSettings<UpdateControlRequest,Control> updateControlSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateControlRequest,Control>