Class AuditManagerSettings (0.3.0) 

public class AuditManagerSettings extends ClientSettings<AuditManagerSettings>

Settings class to configure an instance of AuditManagerClient.

The default instance has everything set to sensible defaults:

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


 // 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
 AuditManagerSettings.Builder auditManagerSettingsBuilder = AuditManagerSettings.newBuilder();
 auditManagerSettingsBuilder
     .enrollResourceSettings()
     .setRetrySettings(
         auditManagerSettingsBuilder
             .enrollResourceSettings()
             .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());
 AuditManagerSettings auditManagerSettings = auditManagerSettingsBuilder.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 generateAuditReport:


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

Inheritance

java.lang.Object > ClientSettings > AuditManagerSettings

Static Methods

create(AuditManagerStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
AuditManagerSettings.Builder

newBuilder(ClientContext clientContext)

public static AuditManagerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
AuditManagerSettings.Builder

newHttpJsonBuilder()

public static AuditManagerSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
AuditManagerSettings.Builder

Constructors

AuditManagerSettings(AuditManagerSettings.Builder settingsBuilder)

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

Methods

enrollResourceSettings()

public UnaryCallSettings<EnrollResourceRequest,Enrollment> enrollResourceSettings()

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

Returns
Type Description
UnaryCallSettings<EnrollResourceRequest,Enrollment>

generateAuditReportOperationSettings()

public OperationCallSettings<GenerateAuditReportRequest,AuditReport,OperationMetadata> generateAuditReportOperationSettings()

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

Returns
Type Description
OperationCallSettings<GenerateAuditReportRequest,AuditReport,OperationMetadata>

generateAuditReportSettings()

public UnaryCallSettings<GenerateAuditReportRequest,Operation> generateAuditReportSettings()

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

Returns
Type Description
UnaryCallSettings<GenerateAuditReportRequest,Operation>

generateAuditScopeReportSettings()

public UnaryCallSettings<GenerateAuditScopeReportRequest,AuditScopeReport> generateAuditScopeReportSettings()

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

Returns
Type Description
UnaryCallSettings<GenerateAuditScopeReportRequest,AuditScopeReport>

getAuditReportSettings()

public UnaryCallSettings<GetAuditReportRequest,AuditReport> getAuditReportSettings()

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

Returns
Type Description
UnaryCallSettings<GetAuditReportRequest,AuditReport>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getResourceEnrollmentStatusSettings()

public UnaryCallSettings<GetResourceEnrollmentStatusRequest,ResourceEnrollmentStatus> getResourceEnrollmentStatusSettings()

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

Returns
Type Description
UnaryCallSettings<GetResourceEnrollmentStatusRequest,ResourceEnrollmentStatus>

listAuditReportsSettings()

public PagedCallSettings<ListAuditReportsRequest,ListAuditReportsResponse,AuditManagerClient.ListAuditReportsPagedResponse> listAuditReportsSettings()

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

Returns
Type Description
PagedCallSettings<ListAuditReportsRequest,ListAuditReportsResponse,ListAuditReportsPagedResponse>

listControlsSettings()

public PagedCallSettings<ListControlsRequest,ListControlsResponse,AuditManagerClient.ListControlsPagedResponse> listControlsSettings()

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

Returns
Type Description
PagedCallSettings<ListControlsRequest,ListControlsResponse,ListControlsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,AuditManagerClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listResourceEnrollmentStatusesSettings()

public PagedCallSettings<ListResourceEnrollmentStatusesRequest,ListResourceEnrollmentStatusesResponse,AuditManagerClient.ListResourceEnrollmentStatusesPagedResponse> listResourceEnrollmentStatusesSettings()

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

Returns
Type Description
PagedCallSettings<ListResourceEnrollmentStatusesRequest,ListResourceEnrollmentStatusesResponse,ListResourceEnrollmentStatusesPagedResponse>

toBuilder()

public AuditManagerSettings.Builder toBuilder()

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

Returns
Type Description
AuditManagerSettings.Builder
Overrides