Class DataAgentServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<DataAgentServiceSettings>
com.google.cloud.geminidataanalytics.v1beta.DataAgentServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class DataAgentServiceSettings
extends ClientSettings<DataAgentServiceSettings>
Settings class to configure an instance of
DataAgentServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (geminidataanalytics.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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getDataAgent:
// 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
DataAgentServiceSettings.Builder dataAgentServiceSettingsBuilder =
DataAgentServiceSettings.newBuilder();
dataAgentServiceSettingsBuilder
.getDataAgentSettings()
.setRetrySettings(
dataAgentServiceSettingsBuilder
.getDataAgentSettings()
.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());
DataAgentServiceSettings dataAgentServiceSettings = dataAgentServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createDataAgent:
// 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
DataAgentServiceSettings.Builder dataAgentServiceSettingsBuilder =
DataAgentServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
dataAgentServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for DataAgentServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDataAgentServiceSettings(DataAgentServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final DataAgentServiceSettingsReturns the object with the settings used for calls to createDataAgent.Returns the object with the settings used for calls to createDataAgent.Returns the object with the settings used for calls to createDataAgentSync.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteDataAgentRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteDataAgent.Returns the object with the settings used for calls to deleteDataAgent.UnaryCallSettings<DeleteDataAgentRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteDataAgentSync.Returns the object with the settings used for calls to getDataAgent.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.PagedCallSettings<ListAccessibleDataAgentsRequest,ListAccessibleDataAgentsResponse, DataAgentServiceClient.ListAccessibleDataAgentsPagedResponse> Returns the object with the settings used for calls to listAccessibleDataAgents.PagedCallSettings<ListDataAgentsRequest,ListDataAgentsResponse, DataAgentServiceClient.ListDataAgentsPagedResponse> Returns the object with the settings used for calls to listDataAgents.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, DataAgentServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateDataAgent.Returns the object with the settings used for calls to updateDataAgent.Returns the object with the settings used for calls to updateDataAgentSync.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
DataAgentServiceSettings
protected DataAgentServiceSettings(DataAgentServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listDataAgentsSettings
public PagedCallSettings<ListDataAgentsRequest,ListDataAgentsResponse, listDataAgentsSettings()DataAgentServiceClient.ListDataAgentsPagedResponse> Returns the object with the settings used for calls to listDataAgents. -
listAccessibleDataAgentsSettings
public PagedCallSettings<ListAccessibleDataAgentsRequest,ListAccessibleDataAgentsResponse, listAccessibleDataAgentsSettings()DataAgentServiceClient.ListAccessibleDataAgentsPagedResponse> Returns the object with the settings used for calls to listAccessibleDataAgents. -
getDataAgentSettings
Returns the object with the settings used for calls to getDataAgent. -
createDataAgentSettings
Returns the object with the settings used for calls to createDataAgent. -
createDataAgentOperationSettings
public OperationCallSettings<CreateDataAgentRequest,DataAgent, createDataAgentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createDataAgent. -
createDataAgentSyncSettings
Returns the object with the settings used for calls to createDataAgentSync. -
updateDataAgentSettings
Returns the object with the settings used for calls to updateDataAgent. -
updateDataAgentOperationSettings
public OperationCallSettings<UpdateDataAgentRequest,DataAgent, updateDataAgentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateDataAgent. -
updateDataAgentSyncSettings
Returns the object with the settings used for calls to updateDataAgentSync. -
deleteDataAgentSettings
Returns the object with the settings used for calls to deleteDataAgent. -
deleteDataAgentOperationSettings
public OperationCallSettings<DeleteDataAgentRequest,com.google.protobuf.Empty, deleteDataAgentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteDataAgent. -
deleteDataAgentSyncSettings
public UnaryCallSettings<DeleteDataAgentRequest,com.google.protobuf.Empty> deleteDataAgentSyncSettings()Returns the object with the settings used for calls to deleteDataAgentSync. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()DataAgentServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
public static final DataAgentServiceSettings create(DataAgentServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<DataAgentServiceSettings>
-