Class OsConfigServiceStubSettings
- java.lang.Object
-
- com.google.api.gax.rpc.StubSettings<OsConfigServiceStubSettings>
-
- com.google.cloud.osconfig.v1.stub.OsConfigServiceStubSettings
-
@Generated("by gapic-generator-java") public class OsConfigServiceStubSettings extends com.google.api.gax.rpc.StubSettings<OsConfigServiceStubSettings>
Settings class to configure an instance ofOsConfigServiceStub
.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();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OsConfigServiceStubSettings.Builder
Builder for OsConfigServiceStubSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
OsConfigServiceStubSettings(OsConfigServiceStubSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.rpc.UnaryCallSettings<PatchJobs.CancelPatchJobRequest,PatchJobs.PatchJob>
cancelPatchJobSettings()
Returns the object with the settings used for calls to cancelPatchJob.com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.CreatePatchDeploymentRequest,PatchDeployments.PatchDeployment>
createPatchDeploymentSettings()
Returns the object with the settings used for calls to createPatchDeployment.OsConfigServiceStub
createStub()
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.Builder
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
defaultGrpcApiClientHeaderProviderBuilder()
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder
defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
defaultHttpJsonApiClientHeaderProviderBuilder()
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.DeletePatchDeploymentRequest,com.google.protobuf.Empty>
deletePatchDeploymentSettings()
Returns the object with the settings used for calls to deletePatchDeployment.com.google.api.gax.rpc.UnaryCallSettings<PatchJobs.ExecutePatchJobRequest,PatchJobs.PatchJob>
executePatchJobSettings()
Returns the object with the settings used for calls to executePatchJob.static String
getDefaultEndpoint()
Returns the default service endpoint.static String
getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.GetPatchDeploymentRequest,PatchDeployments.PatchDeployment>
getPatchDeploymentSettings()
Returns the object with the settings used for calls to getPatchDeployment.com.google.api.gax.rpc.UnaryCallSettings<PatchJobs.GetPatchJobRequest,PatchJobs.PatchJob>
getPatchJobSettings()
Returns the object with the settings used for calls to getPatchJob.com.google.api.gax.rpc.PagedCallSettings<PatchDeployments.ListPatchDeploymentsRequest,PatchDeployments.ListPatchDeploymentsResponse,OsConfigServiceClient.ListPatchDeploymentsPagedResponse>
listPatchDeploymentsSettings()
Returns the object with the settings used for calls to listPatchDeployments.com.google.api.gax.rpc.PagedCallSettings<PatchJobs.ListPatchJobInstanceDetailsRequest,PatchJobs.ListPatchJobInstanceDetailsResponse,OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse>
listPatchJobInstanceDetailsSettings()
Returns the object with the settings used for calls to listPatchJobInstanceDetails.com.google.api.gax.rpc.PagedCallSettings<PatchJobs.ListPatchJobsRequest,PatchJobs.ListPatchJobsResponse,OsConfigServiceClient.ListPatchJobsPagedResponse>
listPatchJobsSettings()
Returns the object with the settings used for calls to listPatchJobs.static OsConfigServiceStubSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static OsConfigServiceStubSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static OsConfigServiceStubSettings.Builder
newHttpJsonBuilder()
Returns a new REST builder for this class.com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.PausePatchDeploymentRequest,PatchDeployments.PatchDeployment>
pausePatchDeploymentSettings()
Returns the object with the settings used for calls to pausePatchDeployment.com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.ResumePatchDeploymentRequest,PatchDeployments.PatchDeployment>
resumePatchDeploymentSettings()
Returns the object with the settings used for calls to resumePatchDeployment.OsConfigServiceStubSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.UpdatePatchDeploymentRequest,PatchDeployments.PatchDeployment>
updatePatchDeploymentSettings()
Returns the object with the settings used for calls to updatePatchDeployment.-
Methods inherited from class com.google.api.gax.rpc.StubSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString
-
-
-
-
Constructor Detail
-
OsConfigServiceStubSettings
protected OsConfigServiceStubSettings(OsConfigServiceStubSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
executePatchJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<PatchJobs.ExecutePatchJobRequest,PatchJobs.PatchJob> executePatchJobSettings()
Returns the object with the settings used for calls to executePatchJob.
-
getPatchJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<PatchJobs.GetPatchJobRequest,PatchJobs.PatchJob> getPatchJobSettings()
Returns the object with the settings used for calls to getPatchJob.
-
cancelPatchJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<PatchJobs.CancelPatchJobRequest,PatchJobs.PatchJob> cancelPatchJobSettings()
Returns the object with the settings used for calls to cancelPatchJob.
-
listPatchJobsSettings
public com.google.api.gax.rpc.PagedCallSettings<PatchJobs.ListPatchJobsRequest,PatchJobs.ListPatchJobsResponse,OsConfigServiceClient.ListPatchJobsPagedResponse> listPatchJobsSettings()
Returns the object with the settings used for calls to listPatchJobs.
-
listPatchJobInstanceDetailsSettings
public com.google.api.gax.rpc.PagedCallSettings<PatchJobs.ListPatchJobInstanceDetailsRequest,PatchJobs.ListPatchJobInstanceDetailsResponse,OsConfigServiceClient.ListPatchJobInstanceDetailsPagedResponse> listPatchJobInstanceDetailsSettings()
Returns the object with the settings used for calls to listPatchJobInstanceDetails.
-
createPatchDeploymentSettings
public com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.CreatePatchDeploymentRequest,PatchDeployments.PatchDeployment> createPatchDeploymentSettings()
Returns the object with the settings used for calls to createPatchDeployment.
-
getPatchDeploymentSettings
public com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.GetPatchDeploymentRequest,PatchDeployments.PatchDeployment> getPatchDeploymentSettings()
Returns the object with the settings used for calls to getPatchDeployment.
-
listPatchDeploymentsSettings
public com.google.api.gax.rpc.PagedCallSettings<PatchDeployments.ListPatchDeploymentsRequest,PatchDeployments.ListPatchDeploymentsResponse,OsConfigServiceClient.ListPatchDeploymentsPagedResponse> listPatchDeploymentsSettings()
Returns the object with the settings used for calls to listPatchDeployments.
-
deletePatchDeploymentSettings
public com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.DeletePatchDeploymentRequest,com.google.protobuf.Empty> deletePatchDeploymentSettings()
Returns the object with the settings used for calls to deletePatchDeployment.
-
updatePatchDeploymentSettings
public com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.UpdatePatchDeploymentRequest,PatchDeployments.PatchDeployment> updatePatchDeploymentSettings()
Returns the object with the settings used for calls to updatePatchDeployment.
-
pausePatchDeploymentSettings
public com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.PausePatchDeploymentRequest,PatchDeployments.PatchDeployment> pausePatchDeploymentSettings()
Returns the object with the settings used for calls to pausePatchDeployment.
-
resumePatchDeploymentSettings
public com.google.api.gax.rpc.UnaryCallSettings<PatchDeployments.ResumePatchDeploymentRequest,PatchDeployments.PatchDeployment> resumePatchDeploymentSettings()
Returns the object with the settings used for calls to resumePatchDeployment.
-
createStub
public OsConfigServiceStub createStub() throws IOException
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
-
getDefaultEndpoint
public static String getDefaultEndpoint()
Returns the default service endpoint.
-
getDefaultMtlsEndpoint
public static String getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.
-
getDefaultServiceScopes
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
-
defaultCredentialsProviderBuilder
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
-
defaultGrpcTransportProviderBuilder
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
-
defaultHttpJsonTransportProviderBuilder
@BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultGrpcApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
-
defaultHttpJsonApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
-
defaultApiClientHeaderProviderBuilder
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static OsConfigServiceStubSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
public static OsConfigServiceStubSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static OsConfigServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public OsConfigServiceStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.StubSettings<OsConfigServiceStubSettings>
-
-