Class OsConfigServiceSettings (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:


 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.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

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 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 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

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>

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()