Class SecurityPostureSettings (0.17.0) 

public class SecurityPostureSettings extends ClientSettings<SecurityPostureSettings>

Settings class to configure an instance of SecurityPostureClient.

The default instance has everything set to sensible defaults:

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


 // 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
 SecurityPostureSettings.Builder securityPostureSettingsBuilder =
     SecurityPostureSettings.newBuilder();
 securityPostureSettingsBuilder
     .getPostureSettings()
     .setRetrySettings(
         securityPostureSettingsBuilder
             .getPostureSettings()
             .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());
 SecurityPostureSettings securityPostureSettings = securityPostureSettingsBuilder.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 createPosture:


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

Inheritance

java.lang.Object > ClientSettings > SecurityPostureSettings

Static Methods

create(SecurityPostureStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
SecurityPostureSettings.Builder

newBuilder(ClientContext clientContext)

public static SecurityPostureSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
SecurityPostureSettings.Builder

newHttpJsonBuilder()

public static SecurityPostureSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
SecurityPostureSettings.Builder

Constructors

SecurityPostureSettings(SecurityPostureSettings.Builder settingsBuilder)

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

Methods

createPostureDeploymentOperationSettings()

public OperationCallSettings<CreatePostureDeploymentRequest,PostureDeployment,OperationMetadata> createPostureDeploymentOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreatePostureDeploymentRequest,PostureDeployment,OperationMetadata>

createPostureDeploymentSettings()

public UnaryCallSettings<CreatePostureDeploymentRequest,Operation> createPostureDeploymentSettings()

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

Returns
Type Description
UnaryCallSettings<CreatePostureDeploymentRequest,Operation>

createPostureOperationSettings()

public OperationCallSettings<CreatePostureRequest,Posture,OperationMetadata> createPostureOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreatePostureRequest,Posture,OperationMetadata>

createPostureSettings()

public UnaryCallSettings<CreatePostureRequest,Operation> createPostureSettings()

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

Returns
Type Description
UnaryCallSettings<CreatePostureRequest,Operation>

deletePostureDeploymentOperationSettings()

public OperationCallSettings<DeletePostureDeploymentRequest,Empty,OperationMetadata> deletePostureDeploymentOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeletePostureDeploymentRequest,Empty,OperationMetadata>

deletePostureDeploymentSettings()

public UnaryCallSettings<DeletePostureDeploymentRequest,Operation> deletePostureDeploymentSettings()

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

Returns
Type Description
UnaryCallSettings<DeletePostureDeploymentRequest,Operation>

deletePostureOperationSettings()

public OperationCallSettings<DeletePostureRequest,Empty,OperationMetadata> deletePostureOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeletePostureRequest,Empty,OperationMetadata>

deletePostureSettings()

public UnaryCallSettings<DeletePostureRequest,Operation> deletePostureSettings()

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

Returns
Type Description
UnaryCallSettings<DeletePostureRequest,Operation>

extractPostureOperationSettings()

public OperationCallSettings<ExtractPostureRequest,Posture,OperationMetadata> extractPostureOperationSettings()

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

Returns
Type Description
OperationCallSettings<ExtractPostureRequest,Posture,OperationMetadata>

extractPostureSettings()

public UnaryCallSettings<ExtractPostureRequest,Operation> extractPostureSettings()

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

Returns
Type Description
UnaryCallSettings<ExtractPostureRequest,Operation>

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>

getPostureDeploymentSettings()

public UnaryCallSettings<GetPostureDeploymentRequest,PostureDeployment> getPostureDeploymentSettings()

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

Returns
Type Description
UnaryCallSettings<GetPostureDeploymentRequest,PostureDeployment>

getPostureSettings()

public UnaryCallSettings<GetPostureRequest,Posture> getPostureSettings()

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

Returns
Type Description
UnaryCallSettings<GetPostureRequest,Posture>

getPostureTemplateSettings()

public UnaryCallSettings<GetPostureTemplateRequest,PostureTemplate> getPostureTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<GetPostureTemplateRequest,PostureTemplate>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,SecurityPostureClient.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>

listPostureDeploymentsSettings()

public PagedCallSettings<ListPostureDeploymentsRequest,ListPostureDeploymentsResponse,SecurityPostureClient.ListPostureDeploymentsPagedResponse> listPostureDeploymentsSettings()

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

Returns
Type Description
PagedCallSettings<ListPostureDeploymentsRequest,ListPostureDeploymentsResponse,ListPostureDeploymentsPagedResponse>

listPostureRevisionsSettings()

public PagedCallSettings<ListPostureRevisionsRequest,ListPostureRevisionsResponse,SecurityPostureClient.ListPostureRevisionsPagedResponse> listPostureRevisionsSettings()

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

Returns
Type Description
PagedCallSettings<ListPostureRevisionsRequest,ListPostureRevisionsResponse,ListPostureRevisionsPagedResponse>

listPostureTemplatesSettings()

public PagedCallSettings<ListPostureTemplatesRequest,ListPostureTemplatesResponse,SecurityPostureClient.ListPostureTemplatesPagedResponse> listPostureTemplatesSettings()

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

Returns
Type Description
PagedCallSettings<ListPostureTemplatesRequest,ListPostureTemplatesResponse,ListPostureTemplatesPagedResponse>

listPosturesSettings()

public PagedCallSettings<ListPosturesRequest,ListPosturesResponse,SecurityPostureClient.ListPosturesPagedResponse> listPosturesSettings()

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

Returns
Type Description
PagedCallSettings<ListPosturesRequest,ListPosturesResponse,ListPosturesPagedResponse>

toBuilder()

public SecurityPostureSettings.Builder toBuilder()

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

Returns
Type Description
SecurityPostureSettings.Builder
Overrides

updatePostureDeploymentOperationSettings()

public OperationCallSettings<UpdatePostureDeploymentRequest,PostureDeployment,OperationMetadata> updatePostureDeploymentOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdatePostureDeploymentRequest,PostureDeployment,OperationMetadata>

updatePostureDeploymentSettings()

public UnaryCallSettings<UpdatePostureDeploymentRequest,Operation> updatePostureDeploymentSettings()

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

Returns
Type Description
UnaryCallSettings<UpdatePostureDeploymentRequest,Operation>

updatePostureOperationSettings()

public OperationCallSettings<UpdatePostureRequest,Posture,OperationMetadata> updatePostureOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdatePostureRequest,Posture,OperationMetadata>

updatePostureSettings()

public UnaryCallSettings<UpdatePostureRequest,Operation> updatePostureSettings()

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

Returns
Type Description
UnaryCallSettings<UpdatePostureRequest,Operation>