Class OsConfigServiceSettings (2.38.0)

Version 2.38.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.6
• 2.4.3
• 2.3.2

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 total timeout of executePatchJob 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
 OsConfigServiceSettings.Builder osConfigServiceSettingsBuilder =
     OsConfigServiceSettings.newBuilder();
 osConfigServiceSettingsBuilder
     .executePatchJobSettings()
     .setRetrySettings(
         osConfigServiceSettingsBuilder
             .executePatchJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OsConfigServiceSettings osConfigServiceSettings = osConfigServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > OsConfigServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(OsConfigServiceStubSettings stub)

public static final OsConfigServiceSettings create(OsConfigServiceStubSettings stub)

Parameter
Name	Description
stub	OsConfigServiceStubSettings

Returns
Type	Description
OsConfigServiceSettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static OsConfigServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
OsConfigServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static OsConfigServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
OsConfigServiceSettings.Builder

newHttpJsonBuilder()

public static OsConfigServiceSettings.Builder newHttpJsonBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a new REST builder for this class.

Returns
Type	Description
OsConfigServiceSettings.Builder

Constructors

OsConfigServiceSettings(OsConfigServiceSettings.Builder settingsBuilder)

protected OsConfigServiceSettings(OsConfigServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	OsConfigServiceSettings.Builder

Methods

cancelPatchJobSettings()

public UnaryCallSettings<PatchJobs.CancelPatchJobRequest,PatchJobs.PatchJob> cancelPatchJobSettings()

Returns the object with the settings used for calls to cancelPatchJob.

Returns
Type	Description
UnaryCallSettings<CancelPatchJobRequest,PatchJob>

createPatchDeploymentSettings()

public UnaryCallSettings<PatchDeployments.CreatePatchDeploymentRequest,PatchDeployments.PatchDeployment> createPatchDeploymentSettings()

Returns the object with the settings used for calls to createPatchDeployment.

Returns
Type	Description
UnaryCallSettings<CreatePatchDeploymentRequest,PatchDeployment>

deletePatchDeploymentSettings()

public UnaryCallSettings<PatchDeployments.DeletePatchDeploymentRequest,Empty> deletePatchDeploymentSettings()

Returns the object with the settings used for calls to deletePatchDeployment.

Returns
Type	Description
UnaryCallSettings<DeletePatchDeploymentRequest,Empty>

executePatchJobSettings()

public UnaryCallSettings<PatchJobs.ExecutePatchJobRequest,PatchJobs.PatchJob> executePatchJobSettings()

Returns the object with the settings used for calls to executePatchJob.

Returns
Type	Description
UnaryCallSettings<ExecutePatchJobRequest,PatchJob>

getPatchDeploymentSettings()

public UnaryCallSettings<PatchDeployments.GetPatchDeploymentRequest,PatchDeployments.PatchDeployment> getPatchDeploymentSettings()

Returns the object with the settings used for calls to getPatchDeployment.

Returns
Type	Description
UnaryCallSettings<GetPatchDeploymentRequest,PatchDeployment>

getPatchJobSettings()

public UnaryCallSettings<PatchJobs.GetPatchJobRequest,PatchJobs.PatchJob> getPatchJobSettings()

Returns the object with the settings used for calls to getPatchJob.

Returns
Type	Description
UnaryCallSettings<GetPatchJobRequest,PatchJob>

listPatchDeploymentsSettings()

public PagedCallSettings<PatchDeployments.ListPatchDeploymentsRequest,PatchDeployments.ListPatchDeploymentsResponse,OsConfigServiceClient.ListPatchDeploymentsPagedResponse> listPatchDeploymentsSettings()

Returns the object with the settings used for calls to listPatchDeployments.

Returns
Type	Description
PagedCallSettings<ListPatchDeploymentsRequest,ListPatchDeploymentsResponse,ListPatchDeploymentsPagedResponse>

listPatchJobInstanceDetailsSettings()

public PagedCallSettings<PatchJobs.ListPatchJobInstanceDetailsRequest,PatchJobs.ListPatchJobInstanceDetailsResponse,OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse> listPatchJobInstanceDetailsSettings()

Returns the object with the settings used for calls to listPatchJobInstanceDetails.

Returns
Type	Description
PagedCallSettings<ListPatchJobInstanceDetailsRequest,ListPatchJobInstanceDetailsResponse,ListPatchJobInstanceDetailsPagedResponse>

listPatchJobsSettings()

public PagedCallSettings<PatchJobs.ListPatchJobsRequest,PatchJobs.ListPatchJobsResponse,OsConfigServiceClient.ListPatchJobsPagedResponse> listPatchJobsSettings()

Returns the object with the settings used for calls to listPatchJobs.

Returns
Type	Description
PagedCallSettings<ListPatchJobsRequest,ListPatchJobsResponse,ListPatchJobsPagedResponse>

pausePatchDeploymentSettings()

public UnaryCallSettings<PatchDeployments.PausePatchDeploymentRequest,PatchDeployments.PatchDeployment> pausePatchDeploymentSettings()

Returns the object with the settings used for calls to pausePatchDeployment.

Returns
Type	Description
UnaryCallSettings<PausePatchDeploymentRequest,PatchDeployment>

resumePatchDeploymentSettings()

public UnaryCallSettings<PatchDeployments.ResumePatchDeploymentRequest,PatchDeployments.PatchDeployment> resumePatchDeploymentSettings()

Returns the object with the settings used for calls to resumePatchDeployment.

Returns
Type	Description
UnaryCallSettings<ResumePatchDeploymentRequest,PatchDeployment>

toBuilder()

public OsConfigServiceSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type	Description
OsConfigServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updatePatchDeploymentSettings()

public UnaryCallSettings<PatchDeployments.UpdatePatchDeploymentRequest,PatchDeployments.PatchDeployment> updatePatchDeploymentSettings()

Returns the object with the settings used for calls to updatePatchDeployment.

Returns
Type	Description
UnaryCallSettings<UpdatePatchDeploymentRequest,PatchDeployment>