Class OsConfigZonalServiceStubSettings (2.6.0)

Version 2.6.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.6
• 2.4.3
• 2.3.2

public class OsConfigZonalServiceStubSettings extends StubSettings<OsConfigZonalServiceStubSettings>

Settings class to configure an instance of OsConfigZonalServiceStub.

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

Inheritance

java.lang.Object > StubSettings > OsConfigZonalServiceStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

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

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 OsConfigZonalServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

Type	Description
OsConfigZonalServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static OsConfigZonalServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	ClientContext

Returns

Type	Description
OsConfigZonalServiceStubSettings.Builder

newHttpJsonBuilder()

public static OsConfigZonalServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
OsConfigZonalServiceStubSettings.Builder

Constructors

OsConfigZonalServiceStubSettings(OsConfigZonalServiceStubSettings.Builder settingsBuilder)

protected OsConfigZonalServiceStubSettings(OsConfigZonalServiceStubSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	OsConfigZonalServiceStubSettings.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>

createStub()

public OsConfigZonalServiceStub createStub()

Returns

Type	Description
OsConfigZonalServiceStub

Exceptions

Type	Description
IOException

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 OsConfigZonalServiceStubSettings.Builder toBuilder()

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

Returns

Type	Description
OsConfigZonalServiceStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()

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>