Class OsConfigServiceStubSettings (2.14.0)

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

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static OsConfigServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
OsConfigServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static OsConfigServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
OsConfigServiceStubSettings.Builder

newHttpJsonBuilder()

public static OsConfigServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
OsConfigServiceStubSettings.Builder

Constructors

OsConfigServiceStubSettings(OsConfigServiceStubSettings.Builder settingsBuilder)

protected OsConfigServiceStubSettings(OsConfigServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderOsConfigServiceStubSettings.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>

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>

createStub()

public OsConfigServiceStub createStub()
Returns
TypeDescription
OsConfigServiceStub
Exceptions
TypeDescription
IOException

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>

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>

pausePatchDeploymentSettings()

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

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

Returns
TypeDescription
UnaryCallSettings<PausePatchDeploymentRequest,PatchDeployment>

resumePatchDeploymentSettings()

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

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

Returns
TypeDescription
UnaryCallSettings<ResumePatchDeploymentRequest,PatchDeployment>