Class OsConfigServiceStubSettings (2.4.3)

Version 2.4.3

• 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 OsConfigServiceStubSettings extends StubSettings<OsConfigServiceStubSettings>

Settings class to configure an instance of OsConfigServiceStub.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 OsConfigServiceStubSettings.Builder osConfigServiceSettingsBuilder =
     OsConfigServiceStubSettings.newBuilder();
 osConfigServiceSettingsBuilder
     .executePatchJobSettings()
     .setRetrySettings(
         osConfigServiceSettingsBuilder
             .executePatchJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OsConfigServiceStubSettings osConfigServiceSettings = osConfigServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > OsConfigServiceStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.toBuilder()

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

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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 OsConfigServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
OsConfigServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static OsConfigServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	ClientContext

Returns

Type	Description
OsConfigServiceStubSettings.Builder

Constructors

OsConfigServiceStubSettings(OsConfigServiceStubSettings.Builder settingsBuilder)

protected OsConfigServiceStubSettings(OsConfigServiceStubSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	OsConfigServiceStubSettings.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>

createGuestPolicySettings()

public UnaryCallSettings<GuestPolicies.CreateGuestPolicyRequest,GuestPolicies.GuestPolicy> createGuestPolicySettings()

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

Returns

Type	Description
UnaryCallSettings<CreateGuestPolicyRequest,GuestPolicy>

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>

createStub()

public OsConfigServiceStub createStub()

Returns

Type	Description
OsConfigServiceStub

Exceptions

Type	Description
IOException

deleteGuestPolicySettings()

public UnaryCallSettings<GuestPolicies.DeleteGuestPolicyRequest,Empty> deleteGuestPolicySettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteGuestPolicyRequest,Empty>

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>

getGuestPolicySettings()

public UnaryCallSettings<GuestPolicies.GetGuestPolicyRequest,GuestPolicies.GuestPolicy> getGuestPolicySettings()

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

Returns

Type	Description
UnaryCallSettings<GetGuestPolicyRequest,GuestPolicy>

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>

listGuestPoliciesSettings()

public PagedCallSettings<GuestPolicies.ListGuestPoliciesRequest,GuestPolicies.ListGuestPoliciesResponse,OsConfigServiceClient.ListGuestPoliciesPagedResponse> listGuestPoliciesSettings()

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

Returns

Type	Description
PagedCallSettings<ListGuestPoliciesRequest,ListGuestPoliciesResponse,ListGuestPoliciesPagedResponse>

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>

lookupEffectiveGuestPolicySettings()

public UnaryCallSettings<GuestPolicies.LookupEffectiveGuestPolicyRequest,GuestPolicies.EffectiveGuestPolicy> lookupEffectiveGuestPolicySettings()

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

Returns

Type	Description
UnaryCallSettings<LookupEffectiveGuestPolicyRequest,EffectiveGuestPolicy>

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 OsConfigServiceStubSettings.Builder toBuilder()

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

Returns

Type	Description
OsConfigServiceStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()

updateGuestPolicySettings()

public UnaryCallSettings<GuestPolicies.UpdateGuestPolicyRequest,GuestPolicies.GuestPolicy> updateGuestPolicySettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateGuestPolicyRequest,GuestPolicy>

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>