Class SecurityCenterSettingsServiceClient (0.58.0)

GitHub RepositoryProduct ReferenceREST Documentation

Service Description: ## API Overview

The SecurityCenterSettingsService is a sub-api of securitycenter.googleapis.com. The service provides methods to manage Security Center Settings, and Component Settings for GCP organizations, folders, projects, and clusters.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ServiceAccountName name = ServiceAccountName.of("[ORGANIZATION]");
   ServiceAccount response = securityCenterSettingsServiceClient.getServiceAccount(name);
 }

Note: close() needs to be called on the SecurityCenterSettingsServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

GetServiceAccount

Retrieves the organizations service account, if it exists, otherwise it creates the organization service account. This API is idempotent and will only create a service account once. On subsequent calls it will return the previously created service account. SHA, SCC and CTD Infra Automation will use this SA. This SA will not have any permissions when created. The UI will provision this via IAM or the user will using their own internal process. This API only creates SAs on the organization. Folders are not supported and projects will use per-project SAs associated with APIs enabled on a project. This API will be called by the UX onboarding workflow.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getServiceAccount(GetServiceAccountRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getServiceAccount(ServiceAccountName name)

  • getServiceAccount(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getServiceAccountCallable()

GetSettings

Gets the Settings.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSettings(GetSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSettings(SettingsName name)

  • getSettings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSettingsCallable()

UpdateSettings

Updates the Settings.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateSettings(UpdateSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateSettings(Settings settings, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateSettingsCallable()

ResetSettings

Reset the organization, folder or project's settings and return the settings of just that resource to the default.

Settings are present at the organization, folder, project, and cluster levels. Using Reset on a sub-organization level will remove that resource's override and result in the parent's settings being used (eg: if Reset on a cluster, project settings will be used).

Using Reset on organization will remove the override that was set and result in default settings being used.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • resetSettings(ResetSettingsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • resetSettingsCallable()

BatchGetSettings

Gets a list of settings.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchGetSettings(BatchGetSettingsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchGetSettingsCallable()

CalculateEffectiveSettings

CalculateEffectiveSettings looks up all of the Security Center Settings resources in the GCP resource hierarchy, and calculates the effective settings on that resource by applying the following rules: * Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). * Product defaults can be overridden at org, folder, project, and cluster levels. * Detectors will be filtered out if they belong to a billing tier the customer has not configured.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • calculateEffectiveSettings(CalculateEffectiveSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • calculateEffectiveSettings(SettingsName name)

  • calculateEffectiveSettings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • calculateEffectiveSettingsCallable()

BatchCalculateEffectiveSettings

Gets a list of effective settings.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchCalculateEffectiveSettings(BatchCalculateEffectiveSettingsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchCalculateEffectiveSettingsCallable()

GetComponentSettings

Gets the Component Settings.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getComponentSettings(GetComponentSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getComponentSettings(ComponentSettingsName name)

  • getComponentSettings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getComponentSettingsCallable()

UpdateComponentSettings

Updates the Component Settings.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateComponentSettings(UpdateComponentSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateComponentSettings(ComponentSettings componentSettings, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateComponentSettingsCallable()

ResetComponentSettings

Reset the organization, folder or project's component settings and return the settings to the default. Settings are present at the organization, folder and project levels. Using Reset for a folder or project will remove the override that was set and result in the organization-level settings being used.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • resetComponentSettings(ResetComponentSettingsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • resetComponentSettingsCallable()

CalculateEffectiveComponentSettings

Gets the Effective Component Settings.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • calculateEffectiveComponentSettings(CalculateEffectiveComponentSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • calculateEffectiveComponentSettings(ComponentSettingsName name)

  • calculateEffectiveComponentSettings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • calculateEffectiveComponentSettingsCallable()

ListDetectors

Retrieves an unordered list of available detectors.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDetectors(ListDetectorsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDetectors(OrganizationName parent)

  • listDetectors(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDetectorsPagedCallable()

  • listDetectorsCallable()

ListComponents

Retrieves an unordered list of available SCC components.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listComponents(ListComponentsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listComponents(OrganizationName parent)

  • listComponents(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listComponentsPagedCallable()

  • listComponentsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of SecurityCenterSettingsServiceSettings to create(). For example:

To customize credentials:


 // 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
 SecurityCenterSettingsServiceSettings securityCenterSettingsServiceSettings =
     SecurityCenterSettingsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create(securityCenterSettingsServiceSettings);

To customize the endpoint:


 // 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
 SecurityCenterSettingsServiceSettings securityCenterSettingsServiceSettings =
     SecurityCenterSettingsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create(securityCenterSettingsServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > SecurityCenterSettingsServiceClient

Static Methods

create()

public static final SecurityCenterSettingsServiceClient create()

Constructs an instance of SecurityCenterSettingsServiceClient with default settings.

Returns
Type Description
SecurityCenterSettingsServiceClient
Exceptions
Type Description
IOException

create(SecurityCenterSettingsServiceSettings settings)

public static final SecurityCenterSettingsServiceClient create(SecurityCenterSettingsServiceSettings settings)

Constructs an instance of SecurityCenterSettingsServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings SecurityCenterSettingsServiceSettings
Returns
Type Description
SecurityCenterSettingsServiceClient
Exceptions
Type Description
IOException

create(SecurityCenterSettingsServiceStub stub)

public static final SecurityCenterSettingsServiceClient create(SecurityCenterSettingsServiceStub stub)

Constructs an instance of SecurityCenterSettingsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SecurityCenterSettingsServiceSettings).

Parameter
Name Description
stub SecurityCenterSettingsServiceStub
Returns
Type Description
SecurityCenterSettingsServiceClient

Constructors

SecurityCenterSettingsServiceClient(SecurityCenterSettingsServiceSettings settings)

protected SecurityCenterSettingsServiceClient(SecurityCenterSettingsServiceSettings settings)

Constructs an instance of SecurityCenterSettingsServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings SecurityCenterSettingsServiceSettings

SecurityCenterSettingsServiceClient(SecurityCenterSettingsServiceStub stub)

protected SecurityCenterSettingsServiceClient(SecurityCenterSettingsServiceStub stub)
Parameter
Name Description
stub SecurityCenterSettingsServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

batchCalculateEffectiveSettings(BatchCalculateEffectiveSettingsRequest request)

public final BatchCalculateEffectiveSettingsResponse batchCalculateEffectiveSettings(BatchCalculateEffectiveSettingsRequest request)

Gets a list of effective settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   BatchCalculateEffectiveSettingsRequest request =
       BatchCalculateEffectiveSettingsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .addAllRequests(new ArrayList<CalculateEffectiveSettingsRequest>())
           .build();
   BatchCalculateEffectiveSettingsResponse response =
       securityCenterSettingsServiceClient.batchCalculateEffectiveSettings(request);
 }
Parameter
Name Description
request BatchCalculateEffectiveSettingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
BatchCalculateEffectiveSettingsResponse

batchCalculateEffectiveSettingsCallable()

public final UnaryCallable<BatchCalculateEffectiveSettingsRequest,BatchCalculateEffectiveSettingsResponse> batchCalculateEffectiveSettingsCallable()

Gets a list of effective settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   BatchCalculateEffectiveSettingsRequest request =
       BatchCalculateEffectiveSettingsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .addAllRequests(new ArrayList<CalculateEffectiveSettingsRequest>())
           .build();
   ApiFuture<BatchCalculateEffectiveSettingsResponse> future =
       securityCenterSettingsServiceClient
           .batchCalculateEffectiveSettingsCallable()
           .futureCall(request);
   // Do something.
   BatchCalculateEffectiveSettingsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<BatchCalculateEffectiveSettingsRequest,BatchCalculateEffectiveSettingsResponse>

batchGetSettings(BatchGetSettingsRequest request)

public final BatchGetSettingsResponse batchGetSettings(BatchGetSettingsRequest request)

Gets a list of settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   BatchGetSettingsRequest request =
       BatchGetSettingsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   BatchGetSettingsResponse response =
       securityCenterSettingsServiceClient.batchGetSettings(request);
 }
Parameter
Name Description
request BatchGetSettingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
BatchGetSettingsResponse

batchGetSettingsCallable()

public final UnaryCallable<BatchGetSettingsRequest,BatchGetSettingsResponse> batchGetSettingsCallable()

Gets a list of settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   BatchGetSettingsRequest request =
       BatchGetSettingsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   ApiFuture<BatchGetSettingsResponse> future =
       securityCenterSettingsServiceClient.batchGetSettingsCallable().futureCall(request);
   // Do something.
   BatchGetSettingsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<BatchGetSettingsRequest,BatchGetSettingsResponse>

calculateEffectiveComponentSettings(CalculateEffectiveComponentSettingsRequest request)

public final ComponentSettings calculateEffectiveComponentSettings(CalculateEffectiveComponentSettingsRequest request)

Gets the Effective Component Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   CalculateEffectiveComponentSettingsRequest request =
       CalculateEffectiveComponentSettingsRequest.newBuilder()
           .setName(
               ComponentSettingsName.ofOrganizationComponentName("[ORGANIZATION]", "[COMPONENT]")
                   .toString())
           .build();
   ComponentSettings response =
       securityCenterSettingsServiceClient.calculateEffectiveComponentSettings(request);
 }
Parameter
Name Description
request CalculateEffectiveComponentSettingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ComponentSettings

calculateEffectiveComponentSettings(ComponentSettingsName name)

public final ComponentSettings calculateEffectiveComponentSettings(ComponentSettingsName name)

Gets the Effective Component Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ComponentSettingsName name =
       ComponentSettingsName.ofOrganizationComponentName("[ORGANIZATION]", "[COMPONENT]");
   ComponentSettings response =
       securityCenterSettingsServiceClient.calculateEffectiveComponentSettings(name);
 }
Parameter
Name Description
name ComponentSettingsName

Required. The effective component settings to retrieve.

Formats: * organizations/{organization}/components/{component}/settings * folders/{folder}/components/{component}/settings * projects/{project}/components/{component}/settings * projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings * projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings * projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings
Returns
Type Description
ComponentSettings

calculateEffectiveComponentSettings(String name)

public final ComponentSettings calculateEffectiveComponentSettings(String name)

Gets the Effective Component Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   String name =
       ComponentSettingsName.ofOrganizationComponentName("[ORGANIZATION]", "[COMPONENT]")
           .toString();
   ComponentSettings response =
       securityCenterSettingsServiceClient.calculateEffectiveComponentSettings(name);
 }
Parameter
Name Description
name String

Required. The effective component settings to retrieve.

Formats: * organizations/{organization}/components/{component}/settings * folders/{folder}/components/{component}/settings * projects/{project}/components/{component}/settings * projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings * projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings * projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings
Returns
Type Description
ComponentSettings

calculateEffectiveComponentSettingsCallable()

public final UnaryCallable<CalculateEffectiveComponentSettingsRequest,ComponentSettings> calculateEffectiveComponentSettingsCallable()

Gets the Effective Component Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   CalculateEffectiveComponentSettingsRequest request =
       CalculateEffectiveComponentSettingsRequest.newBuilder()
           .setName(
               ComponentSettingsName.ofOrganizationComponentName("[ORGANIZATION]", "[COMPONENT]")
                   .toString())
           .build();
   ApiFuture<ComponentSettings> future =
       securityCenterSettingsServiceClient
           .calculateEffectiveComponentSettingsCallable()
           .futureCall(request);
   // Do something.
   ComponentSettings response = future.get();
 }
Returns
Type Description
UnaryCallable<CalculateEffectiveComponentSettingsRequest,ComponentSettings>

calculateEffectiveSettings(CalculateEffectiveSettingsRequest request)

public final Settings calculateEffectiveSettings(CalculateEffectiveSettingsRequest request)

CalculateEffectiveSettings looks up all of the Security Center Settings resources in the GCP resource hierarchy, and calculates the effective settings on that resource by applying the following rules: * Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). * Product defaults can be overridden at org, folder, project, and cluster levels. * Detectors will be filtered out if they belong to a billing tier the customer has not configured.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   CalculateEffectiveSettingsRequest request =
       CalculateEffectiveSettingsRequest.newBuilder()
           .setName(SettingsName.ofOrganizationName("[ORGANIZATION]").toString())
           .build();
   Settings response = securityCenterSettingsServiceClient.calculateEffectiveSettings(request);
 }
Parameter
Name Description
request CalculateEffectiveSettingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Settings

calculateEffectiveSettings(SettingsName name)

public final Settings calculateEffectiveSettings(SettingsName name)

CalculateEffectiveSettings looks up all of the Security Center Settings resources in the GCP resource hierarchy, and calculates the effective settings on that resource by applying the following rules: * Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). * Product defaults can be overridden at org, folder, project, and cluster levels. * Detectors will be filtered out if they belong to a billing tier the customer has not configured.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   SettingsName name = SettingsName.ofOrganizationName("[ORGANIZATION]");
   Settings response = securityCenterSettingsServiceClient.calculateEffectiveSettings(name);
 }
Parameter
Name Description
name SettingsName

Required. The name of the effective settings to retrieve. Formats: * organizations/{organization}/effectiveSettings * folders/{folder}/effectiveSettings * projects/{project}/effectiveSettings * projects/{project}/locations/{location}/clusters/{cluster}/effectiveSettings * projects/{project}/regions/{region}/clusters/{cluster}/effectiveSettings * projects/{project}/zones/{zone}/clusters/{cluster}/effectiveSettings
Returns
Type Description
Settings

calculateEffectiveSettings(String name)

public final Settings calculateEffectiveSettings(String name)

CalculateEffectiveSettings looks up all of the Security Center Settings resources in the GCP resource hierarchy, and calculates the effective settings on that resource by applying the following rules: * Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). * Product defaults can be overridden at org, folder, project, and cluster levels. * Detectors will be filtered out if they belong to a billing tier the customer has not configured.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   String name = SettingsName.ofOrganizationName("[ORGANIZATION]").toString();
   Settings response = securityCenterSettingsServiceClient.calculateEffectiveSettings(name);
 }
Parameter
Name Description
name String

Required. The name of the effective settings to retrieve. Formats: * organizations/{organization}/effectiveSettings * folders/{folder}/effectiveSettings * projects/{project}/effectiveSettings * projects/{project}/locations/{location}/clusters/{cluster}/effectiveSettings * projects/{project}/regions/{region}/clusters/{cluster}/effectiveSettings * projects/{project}/zones/{zone}/clusters/{cluster}/effectiveSettings
Returns
Type Description
Settings

calculateEffectiveSettingsCallable()

public final UnaryCallable<CalculateEffectiveSettingsRequest,Settings> calculateEffectiveSettingsCallable()

CalculateEffectiveSettings looks up all of the Security Center Settings resources in the GCP resource hierarchy, and calculates the effective settings on that resource by applying the following rules: * Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). * Product defaults can be overridden at org, folder, project, and cluster levels. * Detectors will be filtered out if they belong to a billing tier the customer has not configured.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   CalculateEffectiveSettingsRequest request =
       CalculateEffectiveSettingsRequest.newBuilder()
           .setName(SettingsName.ofOrganizationName("[ORGANIZATION]").toString())
           .build();
   ApiFuture<Settings> future =
       securityCenterSettingsServiceClient
           .calculateEffectiveSettingsCallable()
           .futureCall(request);
   // Do something.
   Settings response = future.get();
 }
Returns
Type Description
UnaryCallable<CalculateEffectiveSettingsRequest,Settings>

close()

public final void close()

getComponentSettings(ComponentSettingsName name)

public final ComponentSettings getComponentSettings(ComponentSettingsName name)

Gets the Component Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ComponentSettingsName name =
       ComponentSettingsName.ofOrganizationComponentName("[ORGANIZATION]", "[COMPONENT]");
   ComponentSettings response = securityCenterSettingsServiceClient.getComponentSettings(name);
 }
Parameter
Name Description
name ComponentSettingsName

Required. The component settings to retrieve.

Formats: * organizations/{organization}/components/{component}/settings * folders/{folder}/components/{component}/settings * projects/{project}/components/{component}/settings * projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings * projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings * projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings
Returns
Type Description
ComponentSettings

getComponentSettings(GetComponentSettingsRequest request)

public final ComponentSettings getComponentSettings(GetComponentSettingsRequest request)

Gets the Component Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   GetComponentSettingsRequest request =
       GetComponentSettingsRequest.newBuilder()
           .setName(
               ComponentSettingsName.ofOrganizationComponentName("[ORGANIZATION]", "[COMPONENT]")
                   .toString())
           .build();
   ComponentSettings response =
       securityCenterSettingsServiceClient.getComponentSettings(request);
 }
Parameter
Name Description
request GetComponentSettingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ComponentSettings

getComponentSettings(String name)

public final ComponentSettings getComponentSettings(String name)

Gets the Component Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   String name =
       ComponentSettingsName.ofOrganizationComponentName("[ORGANIZATION]", "[COMPONENT]")
           .toString();
   ComponentSettings response = securityCenterSettingsServiceClient.getComponentSettings(name);
 }
Parameter
Name Description
name String

Required. The component settings to retrieve.

Formats: * organizations/{organization}/components/{component}/settings * folders/{folder}/components/{component}/settings * projects/{project}/components/{component}/settings * projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings * projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings * projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings
Returns
Type Description
ComponentSettings

getComponentSettingsCallable()

public final UnaryCallable<GetComponentSettingsRequest,ComponentSettings> getComponentSettingsCallable()

Gets the Component Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   GetComponentSettingsRequest request =
       GetComponentSettingsRequest.newBuilder()
           .setName(
               ComponentSettingsName.ofOrganizationComponentName("[ORGANIZATION]", "[COMPONENT]")
                   .toString())
           .build();
   ApiFuture<ComponentSettings> future =
       securityCenterSettingsServiceClient.getComponentSettingsCallable().futureCall(request);
   // Do something.
   ComponentSettings response = future.get();
 }
Returns
Type Description
UnaryCallable<GetComponentSettingsRequest,ComponentSettings>

getServiceAccount(GetServiceAccountRequest request)

public final ServiceAccount getServiceAccount(GetServiceAccountRequest request)

Retrieves the organizations service account, if it exists, otherwise it creates the organization service account. This API is idempotent and will only create a service account once. On subsequent calls it will return the previously created service account. SHA, SCC and CTD Infra Automation will use this SA. This SA will not have any permissions when created. The UI will provision this via IAM or the user will using their own internal process. This API only creates SAs on the organization. Folders are not supported and projects will use per-project SAs associated with APIs enabled on a project. This API will be called by the UX onboarding workflow.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   GetServiceAccountRequest request =
       GetServiceAccountRequest.newBuilder()
           .setName(ServiceAccountName.of("[ORGANIZATION]").toString())
           .build();
   ServiceAccount response = securityCenterSettingsServiceClient.getServiceAccount(request);
 }
Parameter
Name Description
request GetServiceAccountRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ServiceAccount

getServiceAccount(ServiceAccountName name)

public final ServiceAccount getServiceAccount(ServiceAccountName name)

Retrieves the organizations service account, if it exists, otherwise it creates the organization service account. This API is idempotent and will only create a service account once. On subsequent calls it will return the previously created service account. SHA, SCC and CTD Infra Automation will use this SA. This SA will not have any permissions when created. The UI will provision this via IAM or the user will using their own internal process. This API only creates SAs on the organization. Folders are not supported and projects will use per-project SAs associated with APIs enabled on a project. This API will be called by the UX onboarding workflow.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ServiceAccountName name = ServiceAccountName.of("[ORGANIZATION]");
   ServiceAccount response = securityCenterSettingsServiceClient.getServiceAccount(name);
 }
Parameter
Name Description
name ServiceAccountName

Required. The relative resource name of the service account resource. Format: * organizations/{organization}/serviceAccount
Returns
Type Description
ServiceAccount

getServiceAccount(String name)

public final ServiceAccount getServiceAccount(String name)

Retrieves the organizations service account, if it exists, otherwise it creates the organization service account. This API is idempotent and will only create a service account once. On subsequent calls it will return the previously created service account. SHA, SCC and CTD Infra Automation will use this SA. This SA will not have any permissions when created. The UI will provision this via IAM or the user will using their own internal process. This API only creates SAs on the organization. Folders are not supported and projects will use per-project SAs associated with APIs enabled on a project. This API will be called by the UX onboarding workflow.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   String name = ServiceAccountName.of("[ORGANIZATION]").toString();
   ServiceAccount response = securityCenterSettingsServiceClient.getServiceAccount(name);
 }
Parameter
Name Description
name String

Required. The relative resource name of the service account resource. Format: * organizations/{organization}/serviceAccount
Returns
Type Description
ServiceAccount

getServiceAccountCallable()

public final UnaryCallable<GetServiceAccountRequest,ServiceAccount> getServiceAccountCallable()

Retrieves the organizations service account, if it exists, otherwise it creates the organization service account. This API is idempotent and will only create a service account once. On subsequent calls it will return the previously created service account. SHA, SCC and CTD Infra Automation will use this SA. This SA will not have any permissions when created. The UI will provision this via IAM or the user will using their own internal process. This API only creates SAs on the organization. Folders are not supported and projects will use per-project SAs associated with APIs enabled on a project. This API will be called by the UX onboarding workflow.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   GetServiceAccountRequest request =
       GetServiceAccountRequest.newBuilder()
           .setName(ServiceAccountName.of("[ORGANIZATION]").toString())
           .build();
   ApiFuture<ServiceAccount> future =
       securityCenterSettingsServiceClient.getServiceAccountCallable().futureCall(request);
   // Do something.
   ServiceAccount response = future.get();
 }
Returns
Type Description
UnaryCallable<GetServiceAccountRequest,ServiceAccount>

getSettings()

public final SecurityCenterSettingsServiceSettings getSettings()
Returns
Type Description
SecurityCenterSettingsServiceSettings

getSettings(GetSettingsRequest request)

public final Settings getSettings(GetSettingsRequest request)

Gets the Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   GetSettingsRequest request =
       GetSettingsRequest.newBuilder()
           .setName(SettingsName.ofOrganizationName("[ORGANIZATION]").toString())
           .build();
   Settings response = securityCenterSettingsServiceClient.getSettings(request);
 }
Parameter
Name Description
request GetSettingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Settings

getSettings(SettingsName name)

public final Settings getSettings(SettingsName name)

Gets the Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   SettingsName name = SettingsName.ofOrganizationName("[ORGANIZATION]");
   Settings response = securityCenterSettingsServiceClient.getSettings(name);
 }
Parameter
Name Description
name SettingsName

Required. The name of the settings to retrieve. Formats: * organizations/{organization}/settings * folders/{folder}/settings * projects/{project}/settings * projects/{project}/locations/{location}/clusters/{cluster}/settings * projects/{project}/regions/{region}/clusters/{cluster}/settings * projects/{project}/zones/{zone}/clusters/{cluster}/settings
Returns
Type Description
Settings

getSettings(String name)

public final Settings getSettings(String name)

Gets the Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   String name = SettingsName.ofOrganizationName("[ORGANIZATION]").toString();
   Settings response = securityCenterSettingsServiceClient.getSettings(name);
 }
Parameter
Name Description
name String

Required. The name of the settings to retrieve. Formats: * organizations/{organization}/settings * folders/{folder}/settings * projects/{project}/settings * projects/{project}/locations/{location}/clusters/{cluster}/settings * projects/{project}/regions/{region}/clusters/{cluster}/settings * projects/{project}/zones/{zone}/clusters/{cluster}/settings
Returns
Type Description
Settings

getSettingsCallable()

public final UnaryCallable<GetSettingsRequest,Settings> getSettingsCallable()

Gets the Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   GetSettingsRequest request =
       GetSettingsRequest.newBuilder()
           .setName(SettingsName.ofOrganizationName("[ORGANIZATION]").toString())
           .build();
   ApiFuture<Settings> future =
       securityCenterSettingsServiceClient.getSettingsCallable().futureCall(request);
   // Do something.
   Settings response = future.get();
 }
Returns
Type Description
UnaryCallable<GetSettingsRequest,Settings>

getStub()

public SecurityCenterSettingsServiceStub getStub()
Returns
Type Description
SecurityCenterSettingsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listComponents(ListComponentsRequest request)

public final SecurityCenterSettingsServiceClient.ListComponentsPagedResponse listComponents(ListComponentsRequest request)

Retrieves an unordered list of available SCC components.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ListComponentsRequest request =
       ListComponentsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (String element :
       securityCenterSettingsServiceClient.listComponents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListComponentsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
SecurityCenterSettingsServiceClient.ListComponentsPagedResponse

listComponents(OrganizationName parent)

public final SecurityCenterSettingsServiceClient.ListComponentsPagedResponse listComponents(OrganizationName parent)

Retrieves an unordered list of available SCC components.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   for (String element :
       securityCenterSettingsServiceClient.listComponents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationName

Required. The parent, which owns this collection of components. Format: * organizations/{organization}
Returns
Type Description
SecurityCenterSettingsServiceClient.ListComponentsPagedResponse

listComponents(String parent)

public final SecurityCenterSettingsServiceClient.ListComponentsPagedResponse listComponents(String parent)

Retrieves an unordered list of available SCC components.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   for (String element :
       securityCenterSettingsServiceClient.listComponents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The parent, which owns this collection of components. Format: * organizations/{organization}
Returns
Type Description
SecurityCenterSettingsServiceClient.ListComponentsPagedResponse

listComponentsCallable()

public final UnaryCallable<ListComponentsRequest,ListComponentsResponse> listComponentsCallable()

Retrieves an unordered list of available SCC components.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ListComponentsRequest request =
       ListComponentsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListComponentsResponse response =
         securityCenterSettingsServiceClient.listComponentsCallable().call(request);
     for (String element : response.getComponentsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListComponentsRequest,ListComponentsResponse>

listComponentsPagedCallable()

public final UnaryCallable<ListComponentsRequest,SecurityCenterSettingsServiceClient.ListComponentsPagedResponse> listComponentsPagedCallable()

Retrieves an unordered list of available SCC components.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ListComponentsRequest request =
       ListComponentsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<String> future =
       securityCenterSettingsServiceClient.listComponentsPagedCallable().futureCall(request);
   // Do something.
   for (String element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListComponentsRequest,ListComponentsPagedResponse>

listDetectors(ListDetectorsRequest request)

public final SecurityCenterSettingsServiceClient.ListDetectorsPagedResponse listDetectors(ListDetectorsRequest request)

Retrieves an unordered list of available detectors.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ListDetectorsRequest request =
       ListDetectorsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Detector element :
       securityCenterSettingsServiceClient.listDetectors(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListDetectorsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
SecurityCenterSettingsServiceClient.ListDetectorsPagedResponse

listDetectors(OrganizationName parent)

public final SecurityCenterSettingsServiceClient.ListDetectorsPagedResponse listDetectors(OrganizationName parent)

Retrieves an unordered list of available detectors.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   for (Detector element :
       securityCenterSettingsServiceClient.listDetectors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationName

Required. The parent, which owns this collection of detectors. Format: * organizations/{organization}
Returns
Type Description
SecurityCenterSettingsServiceClient.ListDetectorsPagedResponse

listDetectors(String parent)

public final SecurityCenterSettingsServiceClient.ListDetectorsPagedResponse listDetectors(String parent)

Retrieves an unordered list of available detectors.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   String parent = OrganizationName.of("[ORGANIZATION]").toString();
   for (Detector element :
       securityCenterSettingsServiceClient.listDetectors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The parent, which owns this collection of detectors. Format: * organizations/{organization}
Returns
Type Description
SecurityCenterSettingsServiceClient.ListDetectorsPagedResponse

listDetectorsCallable()

public final UnaryCallable<ListDetectorsRequest,ListDetectorsResponse> listDetectorsCallable()

Retrieves an unordered list of available detectors.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ListDetectorsRequest request =
       ListDetectorsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDetectorsResponse response =
         securityCenterSettingsServiceClient.listDetectorsCallable().call(request);
     for (Detector element : response.getDetectorsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListDetectorsRequest,ListDetectorsResponse>

listDetectorsPagedCallable()

public final UnaryCallable<ListDetectorsRequest,SecurityCenterSettingsServiceClient.ListDetectorsPagedResponse> listDetectorsPagedCallable()

Retrieves an unordered list of available detectors.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ListDetectorsRequest request =
       ListDetectorsRequest.newBuilder()
           .setParent(OrganizationName.of("[ORGANIZATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Detector> future =
       securityCenterSettingsServiceClient.listDetectorsPagedCallable().futureCall(request);
   // Do something.
   for (Detector element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListDetectorsRequest,ListDetectorsPagedResponse>

resetComponentSettings(ResetComponentSettingsRequest request)

public final void resetComponentSettings(ResetComponentSettingsRequest request)

Reset the organization, folder or project's component settings and return the settings to the default. Settings are present at the organization, folder and project levels. Using Reset for a folder or project will remove the override that was set and result in the organization-level settings being used.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ResetComponentSettingsRequest request =
       ResetComponentSettingsRequest.newBuilder()
           .setName(
               ComponentSettingsName.ofOrganizationComponentName("[ORGANIZATION]", "[COMPONENT]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   securityCenterSettingsServiceClient.resetComponentSettings(request);
 }
Parameter
Name Description
request ResetComponentSettingsRequest

The request object containing all of the parameters for the API call.

resetComponentSettingsCallable()

public final UnaryCallable<ResetComponentSettingsRequest,Empty> resetComponentSettingsCallable()

Reset the organization, folder or project's component settings and return the settings to the default. Settings are present at the organization, folder and project levels. Using Reset for a folder or project will remove the override that was set and result in the organization-level settings being used.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ResetComponentSettingsRequest request =
       ResetComponentSettingsRequest.newBuilder()
           .setName(
               ComponentSettingsName.ofOrganizationComponentName("[ORGANIZATION]", "[COMPONENT]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future =
       securityCenterSettingsServiceClient.resetComponentSettingsCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<ResetComponentSettingsRequest,Empty>

resetSettings(ResetSettingsRequest request)

public final void resetSettings(ResetSettingsRequest request)

Reset the organization, folder or project's settings and return the settings of just that resource to the default.

Settings are present at the organization, folder, project, and cluster levels. Using Reset on a sub-organization level will remove that resource's override and result in the parent's settings being used (eg: if Reset on a cluster, project settings will be used).

Using Reset on organization will remove the override that was set and result in default settings being used.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ResetSettingsRequest request =
       ResetSettingsRequest.newBuilder()
           .setName(SettingsName.ofOrganizationName("[ORGANIZATION]").toString())
           .setEtag("etag3123477")
           .build();
   securityCenterSettingsServiceClient.resetSettings(request);
 }
Parameter
Name Description
request ResetSettingsRequest

The request object containing all of the parameters for the API call.

resetSettingsCallable()

public final UnaryCallable<ResetSettingsRequest,Empty> resetSettingsCallable()

Reset the organization, folder or project's settings and return the settings of just that resource to the default.

Settings are present at the organization, folder, project, and cluster levels. Using Reset on a sub-organization level will remove that resource's override and result in the parent's settings being used (eg: if Reset on a cluster, project settings will be used).

Using Reset on organization will remove the override that was set and result in default settings being used.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ResetSettingsRequest request =
       ResetSettingsRequest.newBuilder()
           .setName(SettingsName.ofOrganizationName("[ORGANIZATION]").toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future =
       securityCenterSettingsServiceClient.resetSettingsCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<ResetSettingsRequest,Empty>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateComponentSettings(ComponentSettings componentSettings, FieldMask updateMask)

public final ComponentSettings updateComponentSettings(ComponentSettings componentSettings, FieldMask updateMask)

Updates the Component Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   ComponentSettings componentSettings = ComponentSettings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ComponentSettings response =
       securityCenterSettingsServiceClient.updateComponentSettings(
           componentSettings, updateMask);
 }
Parameters
Name Description
componentSettings ComponentSettings

Required. The component settings to update.

The component settings' name field is used to identify the component settings to be updated. Formats: * organizations/{organization}/components/{component}/settings * folders/{folder}/components/{component}/settings * projects/{project}/components/{component}/settings * projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings * projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings * projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings
updateMask FieldMask

The list of fields to be updated on the component settings resource.
Returns
Type Description
ComponentSettings

updateComponentSettings(UpdateComponentSettingsRequest request)

public final ComponentSettings updateComponentSettings(UpdateComponentSettingsRequest request)

Updates the Component Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   UpdateComponentSettingsRequest request =
       UpdateComponentSettingsRequest.newBuilder()
           .setComponentSettings(ComponentSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ComponentSettings response =
       securityCenterSettingsServiceClient.updateComponentSettings(request);
 }
Parameter
Name Description
request UpdateComponentSettingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ComponentSettings

updateComponentSettingsCallable()

public final UnaryCallable<UpdateComponentSettingsRequest,ComponentSettings> updateComponentSettingsCallable()

Updates the Component Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   UpdateComponentSettingsRequest request =
       UpdateComponentSettingsRequest.newBuilder()
           .setComponentSettings(ComponentSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ComponentSettings> future =
       securityCenterSettingsServiceClient.updateComponentSettingsCallable().futureCall(request);
   // Do something.
   ComponentSettings response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateComponentSettingsRequest,ComponentSettings>

updateSettings(Settings settings, FieldMask updateMask)

public final Settings updateSettings(Settings settings, FieldMask updateMask)

Updates the Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   Settings settings = Settings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Settings response = securityCenterSettingsServiceClient.updateSettings(settings, updateMask);
 }
Parameters
Name Description
settings Settings

Required. The settings to update.

The settings' name field is used to identify the settings to be updated. Formats: * organizations/{organization}/settings * folders/{folder}/settings * projects/{project}/settings * projects/{project}/locations/{location}/clusters/{cluster}/settings * projects/{project}/regions/{region}/clusters/{cluster}/settings * projects/{project}/zones/{zone}/clusters/{cluster}/settings
updateMask FieldMask

The list of fields to be updated on the settings.
Returns
Type Description
Settings

updateSettings(UpdateSettingsRequest request)

public final Settings updateSettings(UpdateSettingsRequest request)

Updates the Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   UpdateSettingsRequest request =
       UpdateSettingsRequest.newBuilder()
           .setSettings(Settings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Settings response = securityCenterSettingsServiceClient.updateSettings(request);
 }
Parameter
Name Description
request UpdateSettingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Settings

updateSettingsCallable()

public final UnaryCallable<UpdateSettingsRequest,Settings> updateSettingsCallable()

Updates the Settings.

Sample code:


 // 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
 try (SecurityCenterSettingsServiceClient securityCenterSettingsServiceClient =
     SecurityCenterSettingsServiceClient.create()) {
   UpdateSettingsRequest request =
       UpdateSettingsRequest.newBuilder()
           .setSettings(Settings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Settings> future =
       securityCenterSettingsServiceClient.updateSettingsCallable().futureCall(request);
   // Do something.
   Settings response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateSettingsRequest,Settings>