Class OsConfigZonalServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<OsConfigZonalServiceStubSettings>
com.google.cloud.osconfig.v1.stub.OsConfigZonalServiceStubSettings
@Generated("by gapic-generator-java")
public class OsConfigZonalServiceStubSettings
extends StubSettings<OsConfigZonalServiceStubSettings>
Settings class to configure an instance of
OsConfigZonalServiceStub.
The default instance has everything set to sensible defaults:
- The default service address (osconfig.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 getOSPolicyAssignment:
// 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
OsConfigZonalServiceStubSettings.Builder osConfigZonalServiceSettingsBuilder =
OsConfigZonalServiceStubSettings.newBuilder();
osConfigZonalServiceSettingsBuilder
.getOSPolicyAssignmentSettings()
.setRetrySettings(
osConfigZonalServiceSettingsBuilder
.getOSPolicyAssignmentSettings()
.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());
OsConfigZonalServiceStubSettings osConfigZonalServiceSettings =
osConfigZonalServiceSettingsBuilder.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 createOSPolicyAssignment:
// 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
OsConfigZonalServiceStubSettings.Builder osConfigZonalServiceSettingsBuilder =
OsConfigZonalServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
osConfigZonalServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for OsConfigZonalServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedOsConfigZonalServiceStubSettings(OsConfigZonalServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionOperationCallSettings<CreateOSPolicyAssignmentRequest,OSPolicyAssignment, OSPolicyAssignmentOperationMetadata> Returns the object with the settings used for calls to createOSPolicyAssignment.Returns the object with the settings used for calls to createOSPolicyAssignment.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<DeleteOSPolicyAssignmentRequest,com.google.protobuf.Empty, OSPolicyAssignmentOperationMetadata> Returns the object with the settings used for calls to deleteOSPolicyAssignment.Returns the object with the settings used for calls to deleteOSPolicyAssignment.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 getInventory.protected LibraryMetadataReturns the object with the settings used for calls to getOSPolicyAssignmentReport.Returns the object with the settings used for calls to getOSPolicyAssignment.Returns the default service name.Returns the object with the settings used for calls to getVulnerabilityReport.PagedCallSettings<ListInventoriesRequest,ListInventoriesResponse, OsConfigZonalServiceClient.ListInventoriesPagedResponse> Returns the object with the settings used for calls to listInventories.PagedCallSettings<ListOSPolicyAssignmentReportsRequest,ListOSPolicyAssignmentReportsResponse, OsConfigZonalServiceClient.ListOSPolicyAssignmentReportsPagedResponse> Returns the object with the settings used for calls to listOSPolicyAssignmentReports.PagedCallSettings<ListOSPolicyAssignmentRevisionsRequest,ListOSPolicyAssignmentRevisionsResponse, OsConfigZonalServiceClient.ListOSPolicyAssignmentRevisionsPagedResponse> Returns the object with the settings used for calls to listOSPolicyAssignmentRevisions.PagedCallSettings<ListOSPolicyAssignmentsRequest,ListOSPolicyAssignmentsResponse, OsConfigZonalServiceClient.ListOSPolicyAssignmentsPagedResponse> Returns the object with the settings used for calls to listOSPolicyAssignments.PagedCallSettings<ListVulnerabilityReportsRequest,ListVulnerabilityReportsResponse, OsConfigZonalServiceClient.ListVulnerabilityReportsPagedResponse> Returns the object with the settings used for calls to listVulnerabilityReports.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 a builder containing all the values of this settings class.OperationCallSettings<UpdateOSPolicyAssignmentRequest,OSPolicyAssignment, OSPolicyAssignmentOperationMetadata> Returns the object with the settings used for calls to updateOSPolicyAssignment.Returns the object with the settings used for calls to updateOSPolicyAssignment.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
-
OsConfigZonalServiceStubSettings
protected OsConfigZonalServiceStubSettings(OsConfigZonalServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createOSPolicyAssignmentSettings
public UnaryCallSettings<CreateOSPolicyAssignmentRequest,Operation> createOSPolicyAssignmentSettings()Returns the object with the settings used for calls to createOSPolicyAssignment. -
createOSPolicyAssignmentOperationSettings
public OperationCallSettings<CreateOSPolicyAssignmentRequest,OSPolicyAssignment, createOSPolicyAssignmentOperationSettings()OSPolicyAssignmentOperationMetadata> Returns the object with the settings used for calls to createOSPolicyAssignment. -
updateOSPolicyAssignmentSettings
public UnaryCallSettings<UpdateOSPolicyAssignmentRequest,Operation> updateOSPolicyAssignmentSettings()Returns the object with the settings used for calls to updateOSPolicyAssignment. -
updateOSPolicyAssignmentOperationSettings
public OperationCallSettings<UpdateOSPolicyAssignmentRequest,OSPolicyAssignment, updateOSPolicyAssignmentOperationSettings()OSPolicyAssignmentOperationMetadata> Returns the object with the settings used for calls to updateOSPolicyAssignment. -
getOSPolicyAssignmentSettings
public UnaryCallSettings<GetOSPolicyAssignmentRequest,OSPolicyAssignment> getOSPolicyAssignmentSettings()Returns the object with the settings used for calls to getOSPolicyAssignment. -
listOSPolicyAssignmentsSettings
public PagedCallSettings<ListOSPolicyAssignmentsRequest,ListOSPolicyAssignmentsResponse, listOSPolicyAssignmentsSettings()OsConfigZonalServiceClient.ListOSPolicyAssignmentsPagedResponse> Returns the object with the settings used for calls to listOSPolicyAssignments. -
listOSPolicyAssignmentRevisionsSettings
public PagedCallSettings<ListOSPolicyAssignmentRevisionsRequest,ListOSPolicyAssignmentRevisionsResponse, listOSPolicyAssignmentRevisionsSettings()OsConfigZonalServiceClient.ListOSPolicyAssignmentRevisionsPagedResponse> Returns the object with the settings used for calls to listOSPolicyAssignmentRevisions. -
deleteOSPolicyAssignmentSettings
public UnaryCallSettings<DeleteOSPolicyAssignmentRequest,Operation> deleteOSPolicyAssignmentSettings()Returns the object with the settings used for calls to deleteOSPolicyAssignment. -
deleteOSPolicyAssignmentOperationSettings
public OperationCallSettings<DeleteOSPolicyAssignmentRequest,com.google.protobuf.Empty, deleteOSPolicyAssignmentOperationSettings()OSPolicyAssignmentOperationMetadata> Returns the object with the settings used for calls to deleteOSPolicyAssignment. -
getOSPolicyAssignmentReportSettings
public UnaryCallSettings<GetOSPolicyAssignmentReportRequest,OSPolicyAssignmentReport> getOSPolicyAssignmentReportSettings()Returns the object with the settings used for calls to getOSPolicyAssignmentReport. -
listOSPolicyAssignmentReportsSettings
public PagedCallSettings<ListOSPolicyAssignmentReportsRequest,ListOSPolicyAssignmentReportsResponse, listOSPolicyAssignmentReportsSettings()OsConfigZonalServiceClient.ListOSPolicyAssignmentReportsPagedResponse> Returns the object with the settings used for calls to listOSPolicyAssignmentReports. -
getInventorySettings
Returns the object with the settings used for calls to getInventory. -
listInventoriesSettings
public PagedCallSettings<ListInventoriesRequest,ListInventoriesResponse, listInventoriesSettings()OsConfigZonalServiceClient.ListInventoriesPagedResponse> Returns the object with the settings used for calls to listInventories. -
getVulnerabilityReportSettings
public UnaryCallSettings<GetVulnerabilityReportRequest,VulnerabilityReport> getVulnerabilityReportSettings()Returns the object with the settings used for calls to getVulnerabilityReport. -
listVulnerabilityReportsSettings
public PagedCallSettings<ListVulnerabilityReportsRequest,ListVulnerabilityReportsResponse, listVulnerabilityReportsSettings()OsConfigZonalServiceClient.ListVulnerabilityReportsPagedResponse> Returns the object with the settings used for calls to listVulnerabilityReports. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<OsConfigZonalServiceStubSettings>
-
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<OsConfigZonalServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<OsConfigZonalServiceStubSettings>
-