Package com.google.cloud.securitycenter.settings.v1beta1 (0.27.0)

A client to Cloud Security Command Center API

The interfaces provided are listed below, along with usage samples.

SecurityCenterSettingsServiceClient

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.

Sample for SecurityCenterSettingsServiceClient:


 // 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);
 }

Classes

BatchCalculateEffectiveSettingsRequest

Request message for BatchGetEffectiveSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.BatchCalculateEffectiveSettingsRequest

BatchCalculateEffectiveSettingsRequest.Builder

Request message for BatchGetEffectiveSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.BatchCalculateEffectiveSettingsRequest

BatchCalculateEffectiveSettingsResponse

Response message for BatchGetEffectiveSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.BatchCalculateEffectiveSettingsResponse

BatchCalculateEffectiveSettingsResponse.Builder

Response message for BatchGetEffectiveSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.BatchCalculateEffectiveSettingsResponse

BatchGetSettingsRequest

Request message for BatchGetSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.BatchGetSettingsRequest

BatchGetSettingsRequest.Builder

Request message for BatchGetSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.BatchGetSettingsRequest

BatchGetSettingsResponse

Response message for BatchGetSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.BatchGetSettingsResponse

BatchGetSettingsResponse.Builder

Response message for BatchGetSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.BatchGetSettingsResponse

BillingSettings

Billing settings

Protobuf type google.cloud.securitycenter.settings.v1beta1.BillingSettings

BillingSettings.Builder

Billing settings

Protobuf type google.cloud.securitycenter.settings.v1beta1.BillingSettings

BillingSettingsProto

CalculateEffectiveComponentSettingsRequest

Request message for CalculateEffectiveComponentSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.CalculateEffectiveComponentSettingsRequest

CalculateEffectiveComponentSettingsRequest.Builder

Request message for CalculateEffectiveComponentSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.CalculateEffectiveComponentSettingsRequest

CalculateEffectiveSettingsRequest

Request message for CalculateEffectiveSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.CalculateEffectiveSettingsRequest

CalculateEffectiveSettingsRequest.Builder

Request message for CalculateEffectiveSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.CalculateEffectiveSettingsRequest

ComponentSettings

Component Settings for Security Command Center

Protobuf type google.cloud.securitycenter.settings.v1beta1.ComponentSettings

ComponentSettings.Builder

Component Settings for Security Command Center

Protobuf type google.cloud.securitycenter.settings.v1beta1.ComponentSettings

ComponentSettings.DetectorSettings

Settings for each detector.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ComponentSettings.DetectorSettings

ComponentSettings.DetectorSettings.Builder

Settings for each detector.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ComponentSettings.DetectorSettings

ComponentSettingsName

ComponentSettingsName.Builder

Builder for organizations/{organization}/components/{component}/settings.

ComponentSettingsName.FolderComponentBuilder

Builder for folders/{folder}/components/{component}/settings.

ComponentSettingsName.ProjectComponentBuilder

Builder for projects/{project}/components/{component}/settings.

ComponentSettingsName.ProjectLocationClusterComponentBuilder

Builder for projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings.

ComponentSettingsName.ProjectRegionClusterComponentBuilder

Builder for projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings.

ComponentSettingsName.ProjectZoneClusterComponentBuilder

Builder for projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings.

ComponentSettingsProto

ContainerThreatDetectionSettings

User specified settings for KTD

Protobuf type google.cloud.securitycenter.settings.v1beta1.ContainerThreatDetectionSettings

ContainerThreatDetectionSettings.Builder

User specified settings for KTD

Protobuf type google.cloud.securitycenter.settings.v1beta1.ContainerThreatDetectionSettings

Detector

Detector is a set of detectors or scanners act as individual checks done within a component e.g. bad IP, bad domains, IAM anomaly, cryptomining, open firewall, etc. Detector is independent of Organization, meaning each detector must be defined for a given Security Center component under a specified billing tier. Organizations can configure the list of detectors based on their subscribed billing tier.

Defines a detector, its billing tier and any applicable labels.

Protobuf type google.cloud.securitycenter.settings.v1beta1.Detector

Detector.Builder

Defines a detector, its billing tier and any applicable labels.

Protobuf type google.cloud.securitycenter.settings.v1beta1.Detector

DetectorsProto

EventThreatDetectionSettings

User specified settings for ETD

Protobuf type google.cloud.securitycenter.settings.v1beta1.EventThreatDetectionSettings

EventThreatDetectionSettings.Builder

User specified settings for ETD

Protobuf type google.cloud.securitycenter.settings.v1beta1.EventThreatDetectionSettings

GetComponentSettingsRequest

Request message for GetComponentSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.GetComponentSettingsRequest

GetComponentSettingsRequest.Builder

Request message for GetComponentSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.GetComponentSettingsRequest

GetServiceAccountRequest

Request message for GetServiceAccount.

Protobuf type google.cloud.securitycenter.settings.v1beta1.GetServiceAccountRequest

GetServiceAccountRequest.Builder

Request message for GetServiceAccount.

Protobuf type google.cloud.securitycenter.settings.v1beta1.GetServiceAccountRequest

GetSettingsRequest

Request message for GetSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.GetSettingsRequest

GetSettingsRequest.Builder

Request message for GetSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.GetSettingsRequest

ListComponentsRequest

Request message for ListComponents.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ListComponentsRequest

ListComponentsRequest.Builder

Request message for ListComponents.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ListComponentsRequest

ListComponentsResponse

Response message for ListComponents.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ListComponentsResponse

ListComponentsResponse.Builder

Response message for ListComponents.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ListComponentsResponse

ListDetectorsRequest

Request message for ListDetectors.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ListDetectorsRequest

ListDetectorsRequest.Builder

Request message for ListDetectors.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ListDetectorsRequest

ListDetectorsResponse

Response message for ListDetectors.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ListDetectorsResponse

ListDetectorsResponse.Builder

Response message for ListDetectors.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ListDetectorsResponse

OrganizationName

OrganizationName.Builder

Builder for organizations/{organization}.

ResetComponentSettingsRequest

Request message for ResetComponentSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ResetComponentSettingsRequest

ResetComponentSettingsRequest.Builder

Request message for ResetComponentSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ResetComponentSettingsRequest

ResetSettingsRequest

Request message for ResetSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ResetSettingsRequest

ResetSettingsRequest.Builder

Request message for ResetSettings.

Protobuf type google.cloud.securitycenter.settings.v1beta1.ResetSettingsRequest

SecurityCenterSettingsServiceClient

Service Description: ## API Overview

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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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.

SecurityCenterSettingsServiceClient.ListComponentsFixedSizeCollection

SecurityCenterSettingsServiceClient.ListComponentsPage

SecurityCenterSettingsServiceClient.ListComponentsPagedResponse

SecurityCenterSettingsServiceClient.ListDetectorsFixedSizeCollection

SecurityCenterSettingsServiceClient.ListDetectorsPage

SecurityCenterSettingsServiceClient.ListDetectorsPagedResponse

SecurityCenterSettingsServiceGrpc

API Overview

SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service SecurityCenterSettingsService.

API Overview

SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service SecurityCenterSettingsService.

API Overview

SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceImplBase

Base class for the server implementation of the service SecurityCenterSettingsService.

API Overview

SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceStub

A stub to allow clients to do asynchronous rpc calls to service SecurityCenterSettingsService.

API Overview

SecurityCenterSettingsServiceSettings

Settings class to configure an instance of SecurityCenterSettingsServiceClient.

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 total timeout of getServiceAccount to 30 seconds:


 // 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.Builder securityCenterSettingsServiceSettingsBuilder =
     SecurityCenterSettingsServiceSettings.newBuilder();
 securityCenterSettingsServiceSettingsBuilder
     .getServiceAccountSettings()
     .setRetrySettings(
         securityCenterSettingsServiceSettingsBuilder
             .getServiceAccountSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SecurityCenterSettingsServiceSettings securityCenterSettingsServiceSettings =
     securityCenterSettingsServiceSettingsBuilder.build();

Protobuf enum google.cloud.securitycenter.settings.v1beta1.Settings.OnboardingState

Package com.google.cloud.securitycenter.settings.v1beta1 (0.27.0)

SecurityCenterSettingsServiceClient

Classes

API Overview

API Overview

API Overview

API Overview

API Overview

Interfaces

API Overview

Enums