Class OsConfigServiceSettings

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

Constructors

OsConfigServiceSettings(OsConfigServiceSettings.Builder settingsBuilder)

protected OsConfigServiceSettings(OsConfigServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderOsConfigServiceSettings.Builder

Methods

cancelPatchJobSettings()

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

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

Returns
TypeDescription
UnaryCallSettings<CancelPatchJobRequest,PatchJob>

create(OsConfigServiceStubSettings stub)

public static final OsConfigServiceSettings create(OsConfigServiceStubSettings stub)
Parameter
NameDescription
stubOsConfigServiceStubSettings
Returns
TypeDescription
OsConfigServiceSettings
Exceptions
TypeDescription
IOException

createGuestPolicySettings()

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

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

Returns
TypeDescription
UnaryCallSettings<CreateGuestPolicyRequest,GuestPolicy>

createPatchDeploymentSettings()

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

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

Returns
TypeDescription
UnaryCallSettings<CreatePatchDeploymentRequest,PatchDeployment>

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

deleteGuestPolicySettings()

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

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

Returns
TypeDescription
UnaryCallSettings<DeleteGuestPolicyRequest,Empty>

deletePatchDeploymentSettings()

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

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

Returns
TypeDescription
UnaryCallSettings<DeletePatchDeploymentRequest,Empty>

executePatchJobSettings()

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

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

Returns
TypeDescription
UnaryCallSettings<ExecutePatchJobRequest,PatchJob>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

getGuestPolicySettings()

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

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

Returns
TypeDescription
UnaryCallSettings<GetGuestPolicyRequest,GuestPolicy>

getPatchDeploymentSettings()

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

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

Returns
TypeDescription
UnaryCallSettings<GetPatchDeploymentRequest,PatchDeployment>

getPatchJobSettings()

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

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
PagedCallSettings<ListPatchJobsRequest,ListPatchJobsResponse,ListPatchJobsPagedResponse>

lookupEffectiveGuestPolicySettings()

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

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

Returns
TypeDescription
UnaryCallSettings<LookupEffectiveGuestPolicyRequest,EffectiveGuestPolicy>

newBuilder()

public static OsConfigServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
OsConfigServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static OsConfigServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
OsConfigServiceSettings.Builder

toBuilder()

public OsConfigServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
OsConfigServiceSettings.Builder
Overrides

updateGuestPolicySettings()

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

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

Returns
TypeDescription
UnaryCallSettings<UpdateGuestPolicyRequest,GuestPolicy>