Class OsConfigZonalServiceSettings (2.54.0) 

public class OsConfigZonalServiceSettings extends 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 RetrySettings of getOSPolicyAssignment:


 // 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()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 OsConfigZonalServiceSettings osConfigZonalServiceSettings =
     osConfigZonalServiceSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createOSPolicyAssignment:


 // 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();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 osConfigZonalServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > OsConfigZonalServiceSettings

Static Methods

create(OsConfigZonalServiceStubSettings stub)

public static final OsConfigZonalServiceSettings create(OsConfigZonalServiceStubSettings stub)
Parameter
Name Description
stub OsConfigZonalServiceStubSettings
Returns
Type Description
OsConfigZonalServiceSettings
Exceptions
Type Description
IOException

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 gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static OsConfigZonalServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
OsConfigZonalServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static OsConfigZonalServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
OsConfigZonalServiceSettings.Builder

newHttpJsonBuilder()

public static OsConfigZonalServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
OsConfigZonalServiceSettings.Builder

Constructors

OsConfigZonalServiceSettings(OsConfigZonalServiceSettings.Builder settingsBuilder)

protected OsConfigZonalServiceSettings(OsConfigZonalServiceSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder OsConfigZonalServiceSettings.Builder

Methods

createOSPolicyAssignmentOperationSettings()

public OperationCallSettings<CreateOSPolicyAssignmentRequest,OSPolicyAssignment,OSPolicyAssignmentOperationMetadata> createOSPolicyAssignmentOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateOSPolicyAssignmentRequest,OSPolicyAssignment,OSPolicyAssignmentOperationMetadata>

createOSPolicyAssignmentSettings()

public UnaryCallSettings<CreateOSPolicyAssignmentRequest,Operation> createOSPolicyAssignmentSettings()

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

Returns
Type Description
UnaryCallSettings<CreateOSPolicyAssignmentRequest,Operation>

deleteOSPolicyAssignmentOperationSettings()

public OperationCallSettings<DeleteOSPolicyAssignmentRequest,Empty,OSPolicyAssignmentOperationMetadata> deleteOSPolicyAssignmentOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteOSPolicyAssignmentRequest,Empty,OSPolicyAssignmentOperationMetadata>

deleteOSPolicyAssignmentSettings()

public UnaryCallSettings<DeleteOSPolicyAssignmentRequest,Operation> deleteOSPolicyAssignmentSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteOSPolicyAssignmentRequest,Operation>

getInstanceOSPoliciesComplianceSettings() (deprecated)

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

Returns
Type Description
UnaryCallSettings<GetInstanceOSPoliciesComplianceRequest,InstanceOSPoliciesCompliance>

getInventorySettings()

public UnaryCallSettings<GetInventoryRequest,Inventory> getInventorySettings()

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

Returns
Type Description
UnaryCallSettings<GetInventoryRequest,Inventory>

getOSPolicyAssignmentReportSettings()

public UnaryCallSettings<GetOSPolicyAssignmentReportRequest,OSPolicyAssignmentReport> getOSPolicyAssignmentReportSettings()

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

Returns
Type Description
UnaryCallSettings<GetOSPolicyAssignmentReportRequest,OSPolicyAssignmentReport>

getOSPolicyAssignmentSettings()

public UnaryCallSettings<GetOSPolicyAssignmentRequest,OSPolicyAssignment> getOSPolicyAssignmentSettings()

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

Returns
Type Description
UnaryCallSettings<GetOSPolicyAssignmentRequest,OSPolicyAssignment>

getVulnerabilityReportSettings()

public UnaryCallSettings<GetVulnerabilityReportRequest,VulnerabilityReport> getVulnerabilityReportSettings()

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

Returns
Type Description
UnaryCallSettings<GetVulnerabilityReportRequest,VulnerabilityReport>

listInstanceOSPoliciesCompliancesSettings() (deprecated)

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

Returns
Type Description
PagedCallSettings<ListInstanceOSPoliciesCompliancesRequest,ListInstanceOSPoliciesCompliancesResponse,ListInstanceOSPoliciesCompliancesPagedResponse>

listInventoriesSettings()

public PagedCallSettings<ListInventoriesRequest,ListInventoriesResponse,OsConfigZonalServiceClient.ListInventoriesPagedResponse> listInventoriesSettings()

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

Returns
Type Description
PagedCallSettings<ListInventoriesRequest,ListInventoriesResponse,ListInventoriesPagedResponse>

listOSPolicyAssignmentReportsSettings()

public PagedCallSettings<ListOSPolicyAssignmentReportsRequest,ListOSPolicyAssignmentReportsResponse,OsConfigZonalServiceClient.ListOSPolicyAssignmentReportsPagedResponse> listOSPolicyAssignmentReportsSettings()

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

Returns
Type Description
PagedCallSettings<ListOSPolicyAssignmentReportsRequest,ListOSPolicyAssignmentReportsResponse,ListOSPolicyAssignmentReportsPagedResponse>

listOSPolicyAssignmentRevisionsSettings()

public PagedCallSettings<ListOSPolicyAssignmentRevisionsRequest,ListOSPolicyAssignmentRevisionsResponse,OsConfigZonalServiceClient.ListOSPolicyAssignmentRevisionsPagedResponse> listOSPolicyAssignmentRevisionsSettings()

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

Returns
Type Description
PagedCallSettings<ListOSPolicyAssignmentRevisionsRequest,ListOSPolicyAssignmentRevisionsResponse,ListOSPolicyAssignmentRevisionsPagedResponse>

listOSPolicyAssignmentsSettings()

public PagedCallSettings<ListOSPolicyAssignmentsRequest,ListOSPolicyAssignmentsResponse,OsConfigZonalServiceClient.ListOSPolicyAssignmentsPagedResponse> listOSPolicyAssignmentsSettings()

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

Returns
Type Description
PagedCallSettings<ListOSPolicyAssignmentsRequest,ListOSPolicyAssignmentsResponse,ListOSPolicyAssignmentsPagedResponse>

listVulnerabilityReportsSettings()

public PagedCallSettings<ListVulnerabilityReportsRequest,ListVulnerabilityReportsResponse,OsConfigZonalServiceClient.ListVulnerabilityReportsPagedResponse> listVulnerabilityReportsSettings()

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

Returns
Type Description
PagedCallSettings<ListVulnerabilityReportsRequest,ListVulnerabilityReportsResponse,ListVulnerabilityReportsPagedResponse>

toBuilder()

public OsConfigZonalServiceSettings.Builder toBuilder()

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

Returns
Type Description
OsConfigZonalServiceSettings.Builder
Overrides

updateOSPolicyAssignmentOperationSettings()

public OperationCallSettings<UpdateOSPolicyAssignmentRequest,OSPolicyAssignment,OSPolicyAssignmentOperationMetadata> updateOSPolicyAssignmentOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateOSPolicyAssignmentRequest,OSPolicyAssignment,OSPolicyAssignmentOperationMetadata>

updateOSPolicyAssignmentSettings()

public UnaryCallSettings<UpdateOSPolicyAssignmentRequest,Operation> updateOSPolicyAssignmentSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateOSPolicyAssignmentRequest,Operation>