Class OrgPolicyViolationsPreviewServiceSettings (0.49.0)

public class OrgPolicyViolationsPreviewServiceSettings extends ClientSettings<OrgPolicyViolationsPreviewServiceSettings>

Settings class to configure an instance of OrgPolicyViolationsPreviewServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (policysimulator.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 getOrgPolicyViolationsPreview:


 // 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
 OrgPolicyViolationsPreviewServiceSettings.Builder
     orgPolicyViolationsPreviewServiceSettingsBuilder =
         OrgPolicyViolationsPreviewServiceSettings.newBuilder();
 orgPolicyViolationsPreviewServiceSettingsBuilder
     .getOrgPolicyViolationsPreviewSettings()
     .setRetrySettings(
         orgPolicyViolationsPreviewServiceSettingsBuilder
             .getOrgPolicyViolationsPreviewSettings()
             .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());
 OrgPolicyViolationsPreviewServiceSettings orgPolicyViolationsPreviewServiceSettings =
     orgPolicyViolationsPreviewServiceSettingsBuilder.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 createOrgPolicyViolationsPreview:


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

Inheritance

java.lang.Object > ClientSettings > OrgPolicyViolationsPreviewServiceSettings

Static Methods

create(OrgPolicyViolationsPreviewServiceStubSettings stub)

public static final OrgPolicyViolationsPreviewServiceSettings create(OrgPolicyViolationsPreviewServiceStubSettings stub)
Parameter
Name Description
stub OrgPolicyViolationsPreviewServiceStubSettings
Returns
Type Description
OrgPolicyViolationsPreviewServiceSettings
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 OrgPolicyViolationsPreviewServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
OrgPolicyViolationsPreviewServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static OrgPolicyViolationsPreviewServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
OrgPolicyViolationsPreviewServiceSettings.Builder

newHttpJsonBuilder()

public static OrgPolicyViolationsPreviewServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
OrgPolicyViolationsPreviewServiceSettings.Builder

Constructors

OrgPolicyViolationsPreviewServiceSettings(OrgPolicyViolationsPreviewServiceSettings.Builder settingsBuilder)

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

Methods

createOrgPolicyViolationsPreviewOperationSettings()

public OperationCallSettings<CreateOrgPolicyViolationsPreviewRequest,OrgPolicyViolationsPreview,CreateOrgPolicyViolationsPreviewOperationMetadata> createOrgPolicyViolationsPreviewOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateOrgPolicyViolationsPreviewRequest,OrgPolicyViolationsPreview,CreateOrgPolicyViolationsPreviewOperationMetadata>

createOrgPolicyViolationsPreviewSettings()

public UnaryCallSettings<CreateOrgPolicyViolationsPreviewRequest,Operation> createOrgPolicyViolationsPreviewSettings()

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

Returns
Type Description
UnaryCallSettings<CreateOrgPolicyViolationsPreviewRequest,Operation>

getOrgPolicyViolationsPreviewSettings()

public UnaryCallSettings<GetOrgPolicyViolationsPreviewRequest,OrgPolicyViolationsPreview> getOrgPolicyViolationsPreviewSettings()

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

Returns
Type Description
UnaryCallSettings<GetOrgPolicyViolationsPreviewRequest,OrgPolicyViolationsPreview>

listOrgPolicyViolationsPreviewsSettings()

public PagedCallSettings<ListOrgPolicyViolationsPreviewsRequest,ListOrgPolicyViolationsPreviewsResponse,OrgPolicyViolationsPreviewServiceClient.ListOrgPolicyViolationsPreviewsPagedResponse> listOrgPolicyViolationsPreviewsSettings()

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

Returns
Type Description
PagedCallSettings<ListOrgPolicyViolationsPreviewsRequest,ListOrgPolicyViolationsPreviewsResponse,ListOrgPolicyViolationsPreviewsPagedResponse>

listOrgPolicyViolationsSettings()

public PagedCallSettings<ListOrgPolicyViolationsRequest,ListOrgPolicyViolationsResponse,OrgPolicyViolationsPreviewServiceClient.ListOrgPolicyViolationsPagedResponse> listOrgPolicyViolationsSettings()

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

Returns
Type Description
PagedCallSettings<ListOrgPolicyViolationsRequest,ListOrgPolicyViolationsResponse,ListOrgPolicyViolationsPagedResponse>

toBuilder()

public OrgPolicyViolationsPreviewServiceSettings.Builder toBuilder()

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

Returns
Type Description
OrgPolicyViolationsPreviewServiceSettings.Builder
Overrides