Class SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceFutureStub (0.32.0)

public static final class SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceFutureStub extends AbstractFutureStub<SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceFutureStub>

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

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceFutureStub

Methods

batchCalculateEffectiveSettings(BatchCalculateEffectiveSettingsRequest request)

public ListenableFuture<BatchCalculateEffectiveSettingsResponse> batchCalculateEffectiveSettings(BatchCalculateEffectiveSettingsRequest request)

Gets a list of effective settings.

Parameter
NameDescription
requestBatchCalculateEffectiveSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchCalculateEffectiveSettingsResponse>

batchGetSettings(BatchGetSettingsRequest request)

public ListenableFuture<BatchGetSettingsResponse> batchGetSettings(BatchGetSettingsRequest request)

Gets a list of settings.

Parameter
NameDescription
requestBatchGetSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchGetSettingsResponse>

build(Channel channel, CallOptions callOptions)

protected SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

calculateEffectiveComponentSettings(CalculateEffectiveComponentSettingsRequest request)

public ListenableFuture<ComponentSettings> calculateEffectiveComponentSettings(CalculateEffectiveComponentSettingsRequest request)

Gets the Effective Component Settings.

Parameter
NameDescription
requestCalculateEffectiveComponentSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ComponentSettings>

calculateEffectiveSettings(CalculateEffectiveSettingsRequest request)

public ListenableFuture<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.
Parameter
NameDescription
requestCalculateEffectiveSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Settings>

getComponentSettings(GetComponentSettingsRequest request)

public ListenableFuture<ComponentSettings> getComponentSettings(GetComponentSettingsRequest request)

Gets the Component Settings.

Parameter
NameDescription
requestGetComponentSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ComponentSettings>

getServiceAccount(GetServiceAccountRequest request)

public ListenableFuture<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.

Parameter
NameDescription
requestGetServiceAccountRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ServiceAccount>

getSettings(GetSettingsRequest request)

public ListenableFuture<Settings> getSettings(GetSettingsRequest request)

Gets the Settings.

Parameter
NameDescription
requestGetSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Settings>

listComponents(ListComponentsRequest request)

public ListenableFuture<ListComponentsResponse> listComponents(ListComponentsRequest request)

Retrieves an unordered list of available SCC components.

Parameter
NameDescription
requestListComponentsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListComponentsResponse>

listDetectors(ListDetectorsRequest request)

public ListenableFuture<ListDetectorsResponse> listDetectors(ListDetectorsRequest request)

Retrieves an unordered list of available detectors.

Parameter
NameDescription
requestListDetectorsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListDetectorsResponse>

resetComponentSettings(ResetComponentSettingsRequest request)

public ListenableFuture<Empty> 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.

Parameter
NameDescription
requestResetComponentSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

resetSettings(ResetSettingsRequest request)

public ListenableFuture<Empty> 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.

Parameter
NameDescription
requestResetSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

updateComponentSettings(UpdateComponentSettingsRequest request)

public ListenableFuture<ComponentSettings> updateComponentSettings(UpdateComponentSettingsRequest request)

Updates the Component Settings.

Parameter
NameDescription
requestUpdateComponentSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ComponentSettings>

updateSettings(UpdateSettingsRequest request)

public ListenableFuture<Settings> updateSettings(UpdateSettingsRequest request)

Updates the Settings.

Parameter
NameDescription
requestUpdateSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Settings>