Package com.google.cloud.osconfig.v1beta
Class OsConfigServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<OsConfigServiceSettings>
com.google.cloud.osconfig.v1beta.OsConfigServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class OsConfigServiceSettings
extends ClientSettings<OsConfigServiceSettings>
Settings class to configure an instance of
OsConfigServiceClient.
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 executePatchJob:
// 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
OsConfigServiceSettings.Builder osConfigServiceSettingsBuilder =
OsConfigServiceSettings.newBuilder();
osConfigServiceSettingsBuilder
.executePatchJobSettings()
.setRetrySettings(
osConfigServiceSettingsBuilder
.executePatchJobSettings()
.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());
OsConfigServiceSettings osConfigServiceSettings = osConfigServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for OsConfigServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedOsConfigServiceSettings(OsConfigServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to cancelPatchJob.static final OsConfigServiceSettingsReturns the object with the settings used for calls to createGuestPolicy.Returns the object with the settings used for calls to createPatchDeployment.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 TransportChannelProviderUnaryCallSettings<GuestPolicies.DeleteGuestPolicyRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteGuestPolicy.UnaryCallSettings<PatchDeployments.DeletePatchDeploymentRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deletePatchDeployment.Returns the object with the settings used for calls to executePatchJob.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getGuestPolicy.Returns the object with the settings used for calls to getPatchDeployment.Returns the object with the settings used for calls to getPatchJob.PagedCallSettings<GuestPolicies.ListGuestPoliciesRequest,GuestPolicies.ListGuestPoliciesResponse, OsConfigServiceClient.ListGuestPoliciesPagedResponse> Returns the object with the settings used for calls to listGuestPolicies.PagedCallSettings<PatchDeployments.ListPatchDeploymentsRequest,PatchDeployments.ListPatchDeploymentsResponse, OsConfigServiceClient.ListPatchDeploymentsPagedResponse> Returns the object with the settings used for calls to listPatchDeployments.PagedCallSettings<PatchJobs.ListPatchJobInstanceDetailsRequest,PatchJobs.ListPatchJobInstanceDetailsResponse, OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse> Returns the object with the settings used for calls to listPatchJobInstanceDetails.PagedCallSettings<PatchJobs.ListPatchJobsRequest,PatchJobs.ListPatchJobsResponse, OsConfigServiceClient.ListPatchJobsPagedResponse> Returns the object with the settings used for calls to listPatchJobs.UnaryCallSettings<GuestPolicies.LookupEffectiveGuestPolicyRequest,GuestPolicies.EffectiveGuestPolicy> Returns the object with the settings used for calls to lookupEffectiveGuestPolicy.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 pausePatchDeployment.Returns the object with the settings used for calls to resumePatchDeployment.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateGuestPolicy.Returns the object with the settings used for calls to updatePatchDeployment.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
-
OsConfigServiceSettings
protected OsConfigServiceSettings(OsConfigServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
executePatchJobSettings
public UnaryCallSettings<PatchJobs.ExecutePatchJobRequest,PatchJobs.PatchJob> executePatchJobSettings()Returns the object with the settings used for calls to executePatchJob. -
getPatchJobSettings
Returns the object with the settings used for calls to getPatchJob. -
cancelPatchJobSettings
public UnaryCallSettings<PatchJobs.CancelPatchJobRequest,PatchJobs.PatchJob> cancelPatchJobSettings()Returns the object with the settings used for calls to cancelPatchJob. -
listPatchJobsSettings
public PagedCallSettings<PatchJobs.ListPatchJobsRequest,PatchJobs.ListPatchJobsResponse, listPatchJobsSettings()OsConfigServiceClient.ListPatchJobsPagedResponse> Returns the object with the settings used for calls to listPatchJobs. -
listPatchJobInstanceDetailsSettings
public PagedCallSettings<PatchJobs.ListPatchJobInstanceDetailsRequest,PatchJobs.ListPatchJobInstanceDetailsResponse, listPatchJobInstanceDetailsSettings()OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse> Returns the object with the settings used for calls to listPatchJobInstanceDetails. -
createPatchDeploymentSettings
public UnaryCallSettings<PatchDeployments.CreatePatchDeploymentRequest,PatchDeployments.PatchDeployment> createPatchDeploymentSettings()Returns the object with the settings used for calls to createPatchDeployment. -
getPatchDeploymentSettings
public UnaryCallSettings<PatchDeployments.GetPatchDeploymentRequest,PatchDeployments.PatchDeployment> getPatchDeploymentSettings()Returns the object with the settings used for calls to getPatchDeployment. -
listPatchDeploymentsSettings
public PagedCallSettings<PatchDeployments.ListPatchDeploymentsRequest,PatchDeployments.ListPatchDeploymentsResponse, listPatchDeploymentsSettings()OsConfigServiceClient.ListPatchDeploymentsPagedResponse> Returns the object with the settings used for calls to listPatchDeployments. -
deletePatchDeploymentSettings
public UnaryCallSettings<PatchDeployments.DeletePatchDeploymentRequest,com.google.protobuf.Empty> deletePatchDeploymentSettings()Returns the object with the settings used for calls to deletePatchDeployment. -
updatePatchDeploymentSettings
public UnaryCallSettings<PatchDeployments.UpdatePatchDeploymentRequest,PatchDeployments.PatchDeployment> updatePatchDeploymentSettings()Returns the object with the settings used for calls to updatePatchDeployment. -
pausePatchDeploymentSettings
public UnaryCallSettings<PatchDeployments.PausePatchDeploymentRequest,PatchDeployments.PatchDeployment> pausePatchDeploymentSettings()Returns the object with the settings used for calls to pausePatchDeployment. -
resumePatchDeploymentSettings
public UnaryCallSettings<PatchDeployments.ResumePatchDeploymentRequest,PatchDeployments.PatchDeployment> resumePatchDeploymentSettings()Returns the object with the settings used for calls to resumePatchDeployment. -
createGuestPolicySettings
public UnaryCallSettings<GuestPolicies.CreateGuestPolicyRequest,GuestPolicies.GuestPolicy> createGuestPolicySettings()Returns the object with the settings used for calls to createGuestPolicy. -
getGuestPolicySettings
public UnaryCallSettings<GuestPolicies.GetGuestPolicyRequest,GuestPolicies.GuestPolicy> getGuestPolicySettings()Returns the object with the settings used for calls to getGuestPolicy. -
listGuestPoliciesSettings
public PagedCallSettings<GuestPolicies.ListGuestPoliciesRequest,GuestPolicies.ListGuestPoliciesResponse, listGuestPoliciesSettings()OsConfigServiceClient.ListGuestPoliciesPagedResponse> Returns the object with the settings used for calls to listGuestPolicies. -
updateGuestPolicySettings
public UnaryCallSettings<GuestPolicies.UpdateGuestPolicyRequest,GuestPolicies.GuestPolicy> updateGuestPolicySettings()Returns the object with the settings used for calls to updateGuestPolicy. -
deleteGuestPolicySettings
public UnaryCallSettings<GuestPolicies.DeleteGuestPolicyRequest,com.google.protobuf.Empty> deleteGuestPolicySettings()Returns the object with the settings used for calls to deleteGuestPolicy. -
lookupEffectiveGuestPolicySettings
public UnaryCallSettings<GuestPolicies.LookupEffectiveGuestPolicyRequest,GuestPolicies.EffectiveGuestPolicy> lookupEffectiveGuestPolicySettings()Returns the object with the settings used for calls to lookupEffectiveGuestPolicy. -
create
public static final OsConfigServiceSettings create(OsConfigServiceStubSettings 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<OsConfigServiceSettings>
-