Class WorkloadManagerStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<WorkloadManagerStubSettings>
com.google.cloud.workloadmanager.v1.stub.WorkloadManagerStubSettings
@Generated("by gapic-generator-java")
public class WorkloadManagerStubSettings
extends StubSettings<WorkloadManagerStubSettings>
Settings class to configure an instance of
WorkloadManagerStub.
The default instance has everything set to sensible defaults:
- The default service address (workloadmanager.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 getEvaluation:
// 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
WorkloadManagerStubSettings.Builder workloadManagerSettingsBuilder =
WorkloadManagerStubSettings.newBuilder();
workloadManagerSettingsBuilder
.getEvaluationSettings()
.setRetrySettings(
workloadManagerSettingsBuilder
.getEvaluationSettings()
.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());
WorkloadManagerStubSettings workloadManagerSettings = workloadManagerSettingsBuilder.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 createEvaluation:
// 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
WorkloadManagerStubSettings.Builder workloadManagerSettingsBuilder =
WorkloadManagerStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
workloadManagerSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for WorkloadManagerStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedWorkloadManagerStubSettings(WorkloadManagerStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createEvaluation.Returns the object with the settings used for calls to createEvaluation.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<DeleteEvaluationRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteEvaluation.Returns the object with the settings used for calls to deleteEvaluation.OperationCallSettings<DeleteExecutionRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteExecution.Returns the object with the settings used for calls to deleteExecution.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getEvaluation.Returns the object with the settings used for calls to getExecution.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the default service name.PagedCallSettings<ListEvaluationsRequest,ListEvaluationsResponse, WorkloadManagerClient.ListEvaluationsPagedResponse> Returns the object with the settings used for calls to listEvaluations.PagedCallSettings<ListExecutionResultsRequest,ListExecutionResultsResponse, WorkloadManagerClient.ListExecutionResultsPagedResponse> Returns the object with the settings used for calls to listExecutionResults.PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse, WorkloadManagerClient.ListExecutionsPagedResponse> Returns the object with the settings used for calls to listExecutions.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, WorkloadManagerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns the object with the settings used for calls to listRules.PagedCallSettings<ListScannedResourcesRequest,ListScannedResourcesResponse, WorkloadManagerClient.ListScannedResourcesPagedResponse> Returns the object with the settings used for calls to listScannedResources.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 runEvaluation.Returns the object with the settings used for calls to runEvaluation.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateEvaluation.Returns the object with the settings used for calls to updateEvaluation.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
WorkloadManagerStubSettings
protected WorkloadManagerStubSettings(WorkloadManagerStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listEvaluationsSettings
public PagedCallSettings<ListEvaluationsRequest,ListEvaluationsResponse, listEvaluationsSettings()WorkloadManagerClient.ListEvaluationsPagedResponse> Returns the object with the settings used for calls to listEvaluations. -
getEvaluationSettings
Returns the object with the settings used for calls to getEvaluation. -
createEvaluationSettings
Returns the object with the settings used for calls to createEvaluation. -
createEvaluationOperationSettings
public OperationCallSettings<CreateEvaluationRequest,Evaluation, createEvaluationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createEvaluation. -
updateEvaluationSettings
Returns the object with the settings used for calls to updateEvaluation. -
updateEvaluationOperationSettings
public OperationCallSettings<UpdateEvaluationRequest,Evaluation, updateEvaluationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateEvaluation. -
deleteEvaluationSettings
Returns the object with the settings used for calls to deleteEvaluation. -
deleteEvaluationOperationSettings
public OperationCallSettings<DeleteEvaluationRequest,com.google.protobuf.Empty, deleteEvaluationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteEvaluation. -
listExecutionsSettings
public PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse, listExecutionsSettings()WorkloadManagerClient.ListExecutionsPagedResponse> Returns the object with the settings used for calls to listExecutions. -
getExecutionSettings
Returns the object with the settings used for calls to getExecution. -
runEvaluationSettings
Returns the object with the settings used for calls to runEvaluation. -
runEvaluationOperationSettings
public OperationCallSettings<RunEvaluationRequest,Execution, runEvaluationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to runEvaluation. -
deleteExecutionSettings
Returns the object with the settings used for calls to deleteExecution. -
deleteExecutionOperationSettings
public OperationCallSettings<DeleteExecutionRequest,com.google.protobuf.Empty, deleteExecutionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteExecution. -
listExecutionResultsSettings
public PagedCallSettings<ListExecutionResultsRequest,ListExecutionResultsResponse, listExecutionResultsSettings()WorkloadManagerClient.ListExecutionResultsPagedResponse> Returns the object with the settings used for calls to listExecutionResults. -
listRulesSettings
Returns the object with the settings used for calls to listRules. -
listScannedResourcesSettings
public PagedCallSettings<ListScannedResourcesRequest,ListScannedResourcesResponse, listScannedResourcesSettings()WorkloadManagerClient.ListScannedResourcesPagedResponse> Returns the object with the settings used for calls to listScannedResources. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()WorkloadManagerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<WorkloadManagerStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS 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
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
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 classStubSettings<WorkloadManagerStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<WorkloadManagerStubSettings>
-