Package com.google.cloud.retail.v2alpha
Class ControlServiceSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<ControlServiceSettings>
-
- com.google.cloud.retail.v2alpha.ControlServiceSettings
-
@BetaApi @Generated("by gapic-generator-java") public class ControlServiceSettings extends com.google.api.gax.rpc.ClientSettings<ControlServiceSettings>
Settings class to configure an instance ofControlServiceClient
.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 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 ControlServiceSettings.Builder controlServiceSettingsBuilder = ControlServiceSettings.newBuilder(); controlServiceSettingsBuilder .createControlSettings() .setRetrySettings( controlServiceSettingsBuilder .createControlSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); ControlServiceSettings controlServiceSettings = controlServiceSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ControlServiceSettings.Builder
Builder for ControlServiceSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
ControlServiceSettings(ControlServiceSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ControlServiceSettings
create(ControlServiceStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateControlRequest,Control>
createControlSettings()
Returns the object with the settings used for calls to createControl.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.Builder
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder
defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteControlRequest,com.google.protobuf.Empty>
deleteControlSettings()
Returns the object with the settings used for calls to deleteControl.com.google.api.gax.rpc.UnaryCallSettings<GetControlRequest,Control>
getControlSettings()
Returns the object with the settings used for calls to getControl.static String
getDefaultEndpoint()
Returns the default service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.PagedCallSettings<ListControlsRequest,ListControlsResponse,ControlServiceClient.ListControlsPagedResponse>
listControlsSettings()
Returns the object with the settings used for calls to listControls.static ControlServiceSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static ControlServiceSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static ControlServiceSettings.Builder
newHttpJsonBuilder()
Returns a new REST builder for this class.ControlServiceSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.UnaryCallSettings<UpdateControlRequest,Control>
updateControlSettings()
Returns the object with the settings used for calls to updateControl.-
Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
ControlServiceSettings
protected ControlServiceSettings(ControlServiceSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
createControlSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateControlRequest,Control> createControlSettings()
Returns the object with the settings used for calls to createControl.
-
deleteControlSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteControlRequest,com.google.protobuf.Empty> deleteControlSettings()
Returns the object with the settings used for calls to deleteControl.
-
updateControlSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateControlRequest,Control> updateControlSettings()
Returns the object with the settings used for calls to updateControl.
-
getControlSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetControlRequest,Control> getControlSettings()
Returns the object with the settings used for calls to getControl.
-
listControlsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListControlsRequest,ListControlsResponse,ControlServiceClient.ListControlsPagedResponse> listControlsSettings()
Returns the object with the settings used for calls to listControls.
-
create
public static final ControlServiceSettings create(ControlServiceStubSettings stub) throws IOException
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
-
getDefaultEndpoint
public static String getDefaultEndpoint()
Returns the default service endpoint.
-
getDefaultServiceScopes
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
-
defaultCredentialsProviderBuilder
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
-
defaultGrpcTransportProviderBuilder
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
-
defaultHttpJsonTransportProviderBuilder
@BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static ControlServiceSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
@BetaApi public static ControlServiceSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static ControlServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public ControlServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<ControlServiceSettings>
-
-