com.google.cloud.osconfig.v1alpha

Class OsConfigZonalServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<OsConfigZonalServiceSettings>

com.google.cloud.osconfig.v1alpha.OsConfigZonalServiceSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class OsConfigZonalServiceSettings
extends com.google.api.gax.rpc.ClientSettings<OsConfigZonalServiceSettings>

Settings class to configure an instance of OsConfigZonalServiceClient.

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 getOSPolicyAssignment 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
 OsConfigZonalServiceSettings.Builder osConfigZonalServiceSettingsBuilder =
     OsConfigZonalServiceSettings.newBuilder();
 osConfigZonalServiceSettingsBuilder
     .getOSPolicyAssignmentSettings()
     .setRetrySettings(
         osConfigZonalServiceSettingsBuilder
             .getOSPolicyAssignmentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OsConfigZonalServiceSettings osConfigZonalServiceSettings =
     osConfigZonalServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OsConfigZonalServiceSettings.Builder Builder for OsConfigZonalServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OsConfigZonalServiceSettings(OsConfigZonalServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static OsConfigZonalServiceSettings	create(OsConfigZonalServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateOSPolicyAssignmentRequest,OSPolicyAssignment,OSPolicyAssignmentOperationMetadata>	createOSPolicyAssignmentOperationSettings() Returns the object with the settings used for calls to createOSPolicyAssignment.
com.google.api.gax.rpc.UnaryCallSettings<CreateOSPolicyAssignmentRequest,com.google.longrunning.Operation>	createOSPolicyAssignmentSettings() Returns the object with the settings used for calls to createOSPolicyAssignment.
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.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
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.OperationCallSettings<DeleteOSPolicyAssignmentRequest,com.google.protobuf.Empty,OSPolicyAssignmentOperationMetadata>	deleteOSPolicyAssignmentOperationSettings() Returns the object with the settings used for calls to deleteOSPolicyAssignment.
com.google.api.gax.rpc.UnaryCallSettings<DeleteOSPolicyAssignmentRequest,com.google.longrunning.Operation>	deleteOSPolicyAssignmentSettings() Returns the object with the settings used for calls to deleteOSPolicyAssignment.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetInstanceOSPoliciesComplianceRequest,InstanceOSPoliciesCompliance>	getInstanceOSPoliciesComplianceSettings() Deprecated. This method is deprecated and will be removed in the next major version update.
com.google.api.gax.rpc.UnaryCallSettings<GetInventoryRequest,Inventory>	getInventorySettings() Returns the object with the settings used for calls to getInventory.
com.google.api.gax.rpc.UnaryCallSettings<GetOSPolicyAssignmentReportRequest,OSPolicyAssignmentReport>	getOSPolicyAssignmentReportSettings() Returns the object with the settings used for calls to getOSPolicyAssignmentReport.
com.google.api.gax.rpc.UnaryCallSettings<GetOSPolicyAssignmentRequest,OSPolicyAssignment>	getOSPolicyAssignmentSettings() Returns the object with the settings used for calls to getOSPolicyAssignment.
com.google.api.gax.rpc.UnaryCallSettings<GetVulnerabilityReportRequest,VulnerabilityReport>	getVulnerabilityReportSettings() Returns the object with the settings used for calls to getVulnerabilityReport.
com.google.api.gax.rpc.PagedCallSettings<ListInstanceOSPoliciesCompliancesRequest,ListInstanceOSPoliciesCompliancesResponse,OsConfigZonalServiceClient.ListInstanceOSPoliciesCompliancesPagedResponse>	listInstanceOSPoliciesCompliancesSettings() Deprecated. This method is deprecated and will be removed in the next major version update.
com.google.api.gax.rpc.PagedCallSettings<ListInventoriesRequest,ListInventoriesResponse,OsConfigZonalServiceClient.ListInventoriesPagedResponse>	listInventoriesSettings() Returns the object with the settings used for calls to listInventories.
com.google.api.gax.rpc.PagedCallSettings<ListOSPolicyAssignmentReportsRequest,ListOSPolicyAssignmentReportsResponse,OsConfigZonalServiceClient.ListOSPolicyAssignmentReportsPagedResponse>	listOSPolicyAssignmentReportsSettings() Returns the object with the settings used for calls to listOSPolicyAssignmentReports.
com.google.api.gax.rpc.PagedCallSettings<ListOSPolicyAssignmentRevisionsRequest,ListOSPolicyAssignmentRevisionsResponse,OsConfigZonalServiceClient.ListOSPolicyAssignmentRevisionsPagedResponse>	listOSPolicyAssignmentRevisionsSettings() Returns the object with the settings used for calls to listOSPolicyAssignmentRevisions.
com.google.api.gax.rpc.PagedCallSettings<ListOSPolicyAssignmentsRequest,ListOSPolicyAssignmentsResponse,OsConfigZonalServiceClient.ListOSPolicyAssignmentsPagedResponse>	listOSPolicyAssignmentsSettings() Returns the object with the settings used for calls to listOSPolicyAssignments.
com.google.api.gax.rpc.PagedCallSettings<ListVulnerabilityReportsRequest,ListVulnerabilityReportsResponse,OsConfigZonalServiceClient.ListVulnerabilityReportsPagedResponse>	listVulnerabilityReportsSettings() Returns the object with the settings used for calls to listVulnerabilityReports.
static OsConfigZonalServiceSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static OsConfigZonalServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static OsConfigZonalServiceSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
OsConfigZonalServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateOSPolicyAssignmentRequest,OSPolicyAssignment,OSPolicyAssignmentOperationMetadata>	updateOSPolicyAssignmentOperationSettings() Returns the object with the settings used for calls to updateOSPolicyAssignment.
com.google.api.gax.rpc.UnaryCallSettings<UpdateOSPolicyAssignmentRequest,com.google.longrunning.Operation>	updateOSPolicyAssignmentSettings() Returns the object with the settings used for calls to updateOSPolicyAssignment.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OsConfigZonalServiceSettings

protected OsConfigZonalServiceSettings(OsConfigZonalServiceSettings.Builder settingsBuilder)
                                throws IOException

Throws:

IOException

Method Detail

createOSPolicyAssignmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateOSPolicyAssignmentRequest,com.google.longrunning.Operation> createOSPolicyAssignmentSettings()

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

createOSPolicyAssignmentOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateOSPolicyAssignmentRequest,OSPolicyAssignment,OSPolicyAssignmentOperationMetadata> createOSPolicyAssignmentOperationSettings()

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

updateOSPolicyAssignmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateOSPolicyAssignmentRequest,com.google.longrunning.Operation> updateOSPolicyAssignmentSettings()

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

updateOSPolicyAssignmentOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateOSPolicyAssignmentRequest,OSPolicyAssignment,OSPolicyAssignmentOperationMetadata> updateOSPolicyAssignmentOperationSettings()

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

getOSPolicyAssignmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetOSPolicyAssignmentRequest,OSPolicyAssignment> getOSPolicyAssignmentSettings()

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

listOSPolicyAssignmentsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListOSPolicyAssignmentsRequest,ListOSPolicyAssignmentsResponse,OsConfigZonalServiceClient.ListOSPolicyAssignmentsPagedResponse> listOSPolicyAssignmentsSettings()

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

listOSPolicyAssignmentRevisionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListOSPolicyAssignmentRevisionsRequest,ListOSPolicyAssignmentRevisionsResponse,OsConfigZonalServiceClient.ListOSPolicyAssignmentRevisionsPagedResponse> listOSPolicyAssignmentRevisionsSettings()

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

deleteOSPolicyAssignmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteOSPolicyAssignmentRequest,com.google.longrunning.Operation> deleteOSPolicyAssignmentSettings()

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

deleteOSPolicyAssignmentOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteOSPolicyAssignmentRequest,com.google.protobuf.Empty,OSPolicyAssignmentOperationMetadata> deleteOSPolicyAssignmentOperationSettings()

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

getInstanceOSPoliciesComplianceSettings

@Deprecated
public com.google.api.gax.rpc.UnaryCallSettings<GetInstanceOSPoliciesComplianceRequest,InstanceOSPoliciesCompliance> getInstanceOSPoliciesComplianceSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

listInstanceOSPoliciesCompliancesSettings

@Deprecated
public com.google.api.gax.rpc.PagedCallSettings<ListInstanceOSPoliciesCompliancesRequest,ListInstanceOSPoliciesCompliancesResponse,OsConfigZonalServiceClient.ListInstanceOSPoliciesCompliancesPagedResponse> listInstanceOSPoliciesCompliancesSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

getOSPolicyAssignmentReportSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetOSPolicyAssignmentReportRequest,OSPolicyAssignmentReport> getOSPolicyAssignmentReportSettings()

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

listOSPolicyAssignmentReportsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListOSPolicyAssignmentReportsRequest,ListOSPolicyAssignmentReportsResponse,OsConfigZonalServiceClient.ListOSPolicyAssignmentReportsPagedResponse> listOSPolicyAssignmentReportsSettings()

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

getInventorySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetInventoryRequest,Inventory> getInventorySettings()

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

listInventoriesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListInventoriesRequest,ListInventoriesResponse,OsConfigZonalServiceClient.ListInventoriesPagedResponse> listInventoriesSettings()

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

getVulnerabilityReportSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetVulnerabilityReportRequest,VulnerabilityReport> getVulnerabilityReportSettings()

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

listVulnerabilityReportsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListVulnerabilityReportsRequest,ListVulnerabilityReportsResponse,OsConfigZonalServiceClient.ListVulnerabilityReportsPagedResponse> listVulnerabilityReportsSettings()

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

create

public static final OsConfigZonalServiceSettings create(OsConfigZonalServiceStubSettings stub)
                                                 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.

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

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static OsConfigZonalServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static OsConfigZonalServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static OsConfigZonalServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public OsConfigZonalServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<OsConfigZonalServiceSettings>