Class SecurityCenterSettings (2.66.0)

public class SecurityCenterSettings extends ClientSettings<SecurityCenterSettings>

Settings class to configure an instance of SecurityCenterClient.

The default instance has everything set to sensible defaults:

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


 // 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
 SecurityCenterSettings.Builder securityCenterSettingsBuilder =
     SecurityCenterSettings.newBuilder();
 securityCenterSettingsBuilder
     .createSecurityHealthAnalyticsCustomModuleSettings()
     .setRetrySettings(
         securityCenterSettingsBuilder
             .createSecurityHealthAnalyticsCustomModuleSettings()
             .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());
 SecurityCenterSettings securityCenterSettings = securityCenterSettingsBuilder.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 bulkMuteFindings:


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

Inheritance

java.lang.Object > ClientSettings > SecurityCenterSettings

Static Methods

create(SecurityCenterStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
SecurityCenterSettings.Builder

newBuilder(ClientContext clientContext)

public static SecurityCenterSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
SecurityCenterSettings.Builder

newHttpJsonBuilder()

public static SecurityCenterSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
SecurityCenterSettings.Builder

Constructors

SecurityCenterSettings(SecurityCenterSettings.Builder settingsBuilder)

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

Methods

batchCreateResourceValueConfigsSettings()

public UnaryCallSettings<BatchCreateResourceValueConfigsRequest,BatchCreateResourceValueConfigsResponse> batchCreateResourceValueConfigsSettings()

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

bulkMuteFindingsOperationSettings()

public OperationCallSettings<BulkMuteFindingsRequest,BulkMuteFindingsResponse,Empty> bulkMuteFindingsOperationSettings()

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

bulkMuteFindingsSettings()

public UnaryCallSettings<BulkMuteFindingsRequest,Operation> bulkMuteFindingsSettings()

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

createBigQueryExportSettings()

public UnaryCallSettings<CreateBigQueryExportRequest,BigQueryExport> createBigQueryExportSettings()

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

createEventThreatDetectionCustomModuleSettings()

public UnaryCallSettings<CreateEventThreatDetectionCustomModuleRequest,EventThreatDetectionCustomModule> createEventThreatDetectionCustomModuleSettings()

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

createFindingSettings()

public UnaryCallSettings<CreateFindingRequest,Finding> createFindingSettings()

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

Returns
Type Description
UnaryCallSettings<CreateFindingRequest,Finding>

createMuteConfigSettings()

public UnaryCallSettings<CreateMuteConfigRequest,MuteConfig> createMuteConfigSettings()

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

createNotificationConfigSettings()

public UnaryCallSettings<CreateNotificationConfigRequest,NotificationConfig> createNotificationConfigSettings()

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

createSecurityHealthAnalyticsCustomModuleSettings()

public UnaryCallSettings<CreateSecurityHealthAnalyticsCustomModuleRequest,SecurityHealthAnalyticsCustomModule> createSecurityHealthAnalyticsCustomModuleSettings()

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

createSourceSettings()

public UnaryCallSettings<CreateSourceRequest,Source> createSourceSettings()

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

Returns
Type Description
UnaryCallSettings<CreateSourceRequest,Source>

deleteBigQueryExportSettings()

public UnaryCallSettings<DeleteBigQueryExportRequest,Empty> deleteBigQueryExportSettings()

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

deleteEventThreatDetectionCustomModuleSettings()

public UnaryCallSettings<DeleteEventThreatDetectionCustomModuleRequest,Empty> deleteEventThreatDetectionCustomModuleSettings()

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

deleteMuteConfigSettings()

public UnaryCallSettings<DeleteMuteConfigRequest,Empty> deleteMuteConfigSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteMuteConfigRequest,Empty>

deleteNotificationConfigSettings()

public UnaryCallSettings<DeleteNotificationConfigRequest,Empty> deleteNotificationConfigSettings()

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

deleteResourceValueConfigSettings()

public UnaryCallSettings<DeleteResourceValueConfigRequest,Empty> deleteResourceValueConfigSettings()

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

deleteSecurityHealthAnalyticsCustomModuleSettings()

public UnaryCallSettings<DeleteSecurityHealthAnalyticsCustomModuleRequest,Empty> deleteSecurityHealthAnalyticsCustomModuleSettings()

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

getBigQueryExportSettings()

public UnaryCallSettings<GetBigQueryExportRequest,BigQueryExport> getBigQueryExportSettings()

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

getEffectiveEventThreatDetectionCustomModuleSettings()

public UnaryCallSettings<GetEffectiveEventThreatDetectionCustomModuleRequest,EffectiveEventThreatDetectionCustomModule> getEffectiveEventThreatDetectionCustomModuleSettings()

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

getEffectiveSecurityHealthAnalyticsCustomModuleSettings()

public UnaryCallSettings<GetEffectiveSecurityHealthAnalyticsCustomModuleRequest,EffectiveSecurityHealthAnalyticsCustomModule> getEffectiveSecurityHealthAnalyticsCustomModuleSettings()

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

getEventThreatDetectionCustomModuleSettings()

public UnaryCallSettings<GetEventThreatDetectionCustomModuleRequest,EventThreatDetectionCustomModule> getEventThreatDetectionCustomModuleSettings()

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

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getMuteConfigSettings()

public UnaryCallSettings<GetMuteConfigRequest,MuteConfig> getMuteConfigSettings()

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

getNotificationConfigSettings()

public UnaryCallSettings<GetNotificationConfigRequest,NotificationConfig> getNotificationConfigSettings()

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

getOrganizationSettingsSettings()

public UnaryCallSettings<GetOrganizationSettingsRequest,OrganizationSettings> getOrganizationSettingsSettings()

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

getResourceValueConfigSettings()

public UnaryCallSettings<GetResourceValueConfigRequest,ResourceValueConfig> getResourceValueConfigSettings()

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

getSecurityHealthAnalyticsCustomModuleSettings()

public UnaryCallSettings<GetSecurityHealthAnalyticsCustomModuleRequest,SecurityHealthAnalyticsCustomModule> getSecurityHealthAnalyticsCustomModuleSettings()

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

getSimulationSettings()

public UnaryCallSettings<GetSimulationRequest,Simulation> getSimulationSettings()

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

getSourceSettings()

public UnaryCallSettings<GetSourceRequest,Source> getSourceSettings()

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

Returns
Type Description
UnaryCallSettings<GetSourceRequest,Source>

getValuedResourceSettings()

public UnaryCallSettings<GetValuedResourceRequest,ValuedResource> getValuedResourceSettings()

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

groupAssetsSettings() (deprecated)

public PagedCallSettings<GroupAssetsRequest,GroupAssetsResponse,SecurityCenterClient.GroupAssetsPagedResponse> groupAssetsSettings()

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

groupFindingsSettings()

public PagedCallSettings<GroupFindingsRequest,GroupFindingsResponse,SecurityCenterClient.GroupFindingsPagedResponse> groupFindingsSettings()

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

listAssetsSettings() (deprecated)

public PagedCallSettings<ListAssetsRequest,ListAssetsResponse,SecurityCenterClient.ListAssetsPagedResponse> listAssetsSettings()

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

listAttackPathsSettings()

public PagedCallSettings<ListAttackPathsRequest,ListAttackPathsResponse,SecurityCenterClient.ListAttackPathsPagedResponse> listAttackPathsSettings()

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

listBigQueryExportsSettings()

public PagedCallSettings<ListBigQueryExportsRequest,ListBigQueryExportsResponse,SecurityCenterClient.ListBigQueryExportsPagedResponse> listBigQueryExportsSettings()

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

listDescendantEventThreatDetectionCustomModulesSettings()

public PagedCallSettings<ListDescendantEventThreatDetectionCustomModulesRequest,ListDescendantEventThreatDetectionCustomModulesResponse,SecurityCenterClient.ListDescendantEventThreatDetectionCustomModulesPagedResponse> listDescendantEventThreatDetectionCustomModulesSettings()

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

listDescendantSecurityHealthAnalyticsCustomModulesSettings()

public PagedCallSettings<ListDescendantSecurityHealthAnalyticsCustomModulesRequest,ListDescendantSecurityHealthAnalyticsCustomModulesResponse,SecurityCenterClient.ListDescendantSecurityHealthAnalyticsCustomModulesPagedResponse> listDescendantSecurityHealthAnalyticsCustomModulesSettings()

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

listEffectiveEventThreatDetectionCustomModulesSettings()

public PagedCallSettings<ListEffectiveEventThreatDetectionCustomModulesRequest,ListEffectiveEventThreatDetectionCustomModulesResponse,SecurityCenterClient.ListEffectiveEventThreatDetectionCustomModulesPagedResponse> listEffectiveEventThreatDetectionCustomModulesSettings()

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

listEffectiveSecurityHealthAnalyticsCustomModulesSettings()

public PagedCallSettings<ListEffectiveSecurityHealthAnalyticsCustomModulesRequest,ListEffectiveSecurityHealthAnalyticsCustomModulesResponse,SecurityCenterClient.ListEffectiveSecurityHealthAnalyticsCustomModulesPagedResponse> listEffectiveSecurityHealthAnalyticsCustomModulesSettings()

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

listEventThreatDetectionCustomModulesSettings()

public PagedCallSettings<ListEventThreatDetectionCustomModulesRequest,ListEventThreatDetectionCustomModulesResponse,SecurityCenterClient.ListEventThreatDetectionCustomModulesPagedResponse> listEventThreatDetectionCustomModulesSettings()

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

listFindingsSettings()

public PagedCallSettings<ListFindingsRequest,ListFindingsResponse,SecurityCenterClient.ListFindingsPagedResponse> listFindingsSettings()

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

listMuteConfigsSettings()

public PagedCallSettings<ListMuteConfigsRequest,ListMuteConfigsResponse,SecurityCenterClient.ListMuteConfigsPagedResponse> listMuteConfigsSettings()

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

listNotificationConfigsSettings()

public PagedCallSettings<ListNotificationConfigsRequest,ListNotificationConfigsResponse,SecurityCenterClient.ListNotificationConfigsPagedResponse> listNotificationConfigsSettings()

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

listResourceValueConfigsSettings()

public PagedCallSettings<ListResourceValueConfigsRequest,ListResourceValueConfigsResponse,SecurityCenterClient.ListResourceValueConfigsPagedResponse> listResourceValueConfigsSettings()

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

listSecurityHealthAnalyticsCustomModulesSettings()

public PagedCallSettings<ListSecurityHealthAnalyticsCustomModulesRequest,ListSecurityHealthAnalyticsCustomModulesResponse,SecurityCenterClient.ListSecurityHealthAnalyticsCustomModulesPagedResponse> listSecurityHealthAnalyticsCustomModulesSettings()

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

listSourcesSettings()

public PagedCallSettings<ListSourcesRequest,ListSourcesResponse,SecurityCenterClient.ListSourcesPagedResponse> listSourcesSettings()

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

listValuedResourcesSettings()

public PagedCallSettings<ListValuedResourcesRequest,ListValuedResourcesResponse,SecurityCenterClient.ListValuedResourcesPagedResponse> listValuedResourcesSettings()

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

runAssetDiscoveryOperationSettings() (deprecated)

public OperationCallSettings<RunAssetDiscoveryRequest,RunAssetDiscoveryResponse,Empty> runAssetDiscoveryOperationSettings()

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

runAssetDiscoverySettings() (deprecated)

public UnaryCallSettings<RunAssetDiscoveryRequest,Operation> runAssetDiscoverySettings()

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

setFindingStateSettings()

public UnaryCallSettings<SetFindingStateRequest,Finding> setFindingStateSettings()

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

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

setMuteSettings()

public UnaryCallSettings<SetMuteRequest,Finding> setMuteSettings()

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

Returns
Type Description
UnaryCallSettings<SetMuteRequest,Finding>

simulateSecurityHealthAnalyticsCustomModuleSettings()

public UnaryCallSettings<SimulateSecurityHealthAnalyticsCustomModuleRequest,SimulateSecurityHealthAnalyticsCustomModuleResponse> simulateSecurityHealthAnalyticsCustomModuleSettings()

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

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public SecurityCenterSettings.Builder toBuilder()

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

Returns
Type Description
SecurityCenterSettings.Builder
Overrides

updateBigQueryExportSettings()

public UnaryCallSettings<UpdateBigQueryExportRequest,BigQueryExport> updateBigQueryExportSettings()

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

updateEventThreatDetectionCustomModuleSettings()

public UnaryCallSettings<UpdateEventThreatDetectionCustomModuleRequest,EventThreatDetectionCustomModule> updateEventThreatDetectionCustomModuleSettings()

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

updateExternalSystemSettings()

public UnaryCallSettings<UpdateExternalSystemRequest,ExternalSystem> updateExternalSystemSettings()

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

updateFindingSettings()

public UnaryCallSettings<UpdateFindingRequest,Finding> updateFindingSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateFindingRequest,Finding>

updateMuteConfigSettings()

public UnaryCallSettings<UpdateMuteConfigRequest,MuteConfig> updateMuteConfigSettings()

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

updateNotificationConfigSettings()

public UnaryCallSettings<UpdateNotificationConfigRequest,NotificationConfig> updateNotificationConfigSettings()

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

updateOrganizationSettingsSettings()

public UnaryCallSettings<UpdateOrganizationSettingsRequest,OrganizationSettings> updateOrganizationSettingsSettings()

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

updateResourceValueConfigSettings()

public UnaryCallSettings<UpdateResourceValueConfigRequest,ResourceValueConfig> updateResourceValueConfigSettings()

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

updateSecurityHealthAnalyticsCustomModuleSettings()

public UnaryCallSettings<UpdateSecurityHealthAnalyticsCustomModuleRequest,SecurityHealthAnalyticsCustomModule> updateSecurityHealthAnalyticsCustomModuleSettings()

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

updateSecurityMarksSettings()

public UnaryCallSettings<UpdateSecurityMarksRequest,SecurityMarks> updateSecurityMarksSettings()

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

updateSourceSettings()

public UnaryCallSettings<UpdateSourceRequest,Source> updateSourceSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateSourceRequest,Source>

validateEventThreatDetectionCustomModuleSettings()

public UnaryCallSettings<ValidateEventThreatDetectionCustomModuleRequest,ValidateEventThreatDetectionCustomModuleResponse> validateEventThreatDetectionCustomModuleSettings()

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