Class SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceStub (0.6.2)

public static final class SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceStub extends AbstractAsyncStub<SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceStub>

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.AbstractAsyncStub > SecurityCenterSettingsServiceGrpc.SecurityCenterSettingsServiceStub

Methods

batchCalculateEffectiveSettings(BatchCalculateEffectiveSettingsRequest request, StreamObserver<BatchCalculateEffectiveSettingsResponse> responseObserver)

public void batchCalculateEffectiveSettings(BatchCalculateEffectiveSettingsRequest request, StreamObserver<BatchCalculateEffectiveSettingsResponse> responseObserver)

Gets a list of effective settings.

Parameters
NameDescription
requestBatchCalculateEffectiveSettingsRequest
responseObserverio.grpc.stub.StreamObserver<BatchCalculateEffectiveSettingsResponse>

batchGetSettings(BatchGetSettingsRequest request, StreamObserver<BatchGetSettingsResponse> responseObserver)

public void batchGetSettings(BatchGetSettingsRequest request, StreamObserver<BatchGetSettingsResponse> responseObserver)

Gets a list of settings.

Parameters
NameDescription
requestBatchGetSettingsRequest
responseObserverio.grpc.stub.StreamObserver<BatchGetSettingsResponse>

build(Channel channel, CallOptions callOptions)

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

calculateEffectiveComponentSettings(CalculateEffectiveComponentSettingsRequest request, StreamObserver<ComponentSettings> responseObserver)

public void calculateEffectiveComponentSettings(CalculateEffectiveComponentSettingsRequest request, StreamObserver<ComponentSettings> responseObserver)

Gets the Effective Component Settings.

Parameters
NameDescription
requestCalculateEffectiveComponentSettingsRequest
responseObserverio.grpc.stub.StreamObserver<ComponentSettings>

calculateEffectiveSettings(CalculateEffectiveSettingsRequest request, StreamObserver<Settings> responseObserver)

public void calculateEffectiveSettings(CalculateEffectiveSettingsRequest request, StreamObserver<Settings> responseObserver)

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.
Parameters
NameDescription
requestCalculateEffectiveSettingsRequest
responseObserverio.grpc.stub.StreamObserver<Settings>

getComponentSettings(GetComponentSettingsRequest request, StreamObserver<ComponentSettings> responseObserver)

public void getComponentSettings(GetComponentSettingsRequest request, StreamObserver<ComponentSettings> responseObserver)

Gets the Component Settings.

Parameters
NameDescription
requestGetComponentSettingsRequest
responseObserverio.grpc.stub.StreamObserver<ComponentSettings>

getServiceAccount(GetServiceAccountRequest request, StreamObserver<ServiceAccount> responseObserver)

public void getServiceAccount(GetServiceAccountRequest request, StreamObserver<ServiceAccount> responseObserver)

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.

Parameters
NameDescription
requestGetServiceAccountRequest
responseObserverio.grpc.stub.StreamObserver<ServiceAccount>

getSettings(GetSettingsRequest request, StreamObserver<Settings> responseObserver)

public void getSettings(GetSettingsRequest request, StreamObserver<Settings> responseObserver)

Gets the Settings.

Parameters
NameDescription
requestGetSettingsRequest
responseObserverio.grpc.stub.StreamObserver<Settings>

listComponents(ListComponentsRequest request, StreamObserver<ListComponentsResponse> responseObserver)

public void listComponents(ListComponentsRequest request, StreamObserver<ListComponentsResponse> responseObserver)

Retrieves an unordered list of available SCC components.

Parameters
NameDescription
requestListComponentsRequest
responseObserverio.grpc.stub.StreamObserver<ListComponentsResponse>

listDetectors(ListDetectorsRequest request, StreamObserver<ListDetectorsResponse> responseObserver)

public void listDetectors(ListDetectorsRequest request, StreamObserver<ListDetectorsResponse> responseObserver)

Retrieves an unordered list of available detectors.

Parameters
NameDescription
requestListDetectorsRequest
responseObserverio.grpc.stub.StreamObserver<ListDetectorsResponse>

resetComponentSettings(ResetComponentSettingsRequest request, StreamObserver<Empty> responseObserver)

public void resetComponentSettings(ResetComponentSettingsRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
NameDescription
requestResetComponentSettingsRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

resetSettings(ResetSettingsRequest request, StreamObserver<Empty> responseObserver)

public void resetSettings(ResetSettingsRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
NameDescription
requestResetSettingsRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

updateComponentSettings(UpdateComponentSettingsRequest request, StreamObserver<ComponentSettings> responseObserver)

public void updateComponentSettings(UpdateComponentSettingsRequest request, StreamObserver<ComponentSettings> responseObserver)

Updates the Component Settings.

Parameters
NameDescription
requestUpdateComponentSettingsRequest
responseObserverio.grpc.stub.StreamObserver<ComponentSettings>

updateSettings(UpdateSettingsRequest request, StreamObserver<Settings> responseObserver)

public void updateSettings(UpdateSettingsRequest request, StreamObserver<Settings> responseObserver)

Updates the Settings.

Parameters
NameDescription
requestUpdateSettingsRequest
responseObserverio.grpc.stub.StreamObserver<Settings>