Google Cloud Security Command Center Settings v1beta1 API - Class SecurityCenterSettingsService.SecurityCenterSettingsServiceBase (2.0.0-beta02)

[BindServiceMethod(typeof(SecurityCenterSettingsService), "BindService")]
public abstract class SecurityCenterSettingsService.SecurityCenterSettingsServiceBase

Reference documentation and code samples for the Google Cloud Security Command Center Settings v1beta1 API class SecurityCenterSettingsService.SecurityCenterSettingsServiceBase.

Base class for server-side implementations of SecurityCenterSettingsService

Inheritance

object > SecurityCenterSettingsService.SecurityCenterSettingsServiceBase

Namespace

Google.Cloud.SecurityCenter.Settings.V1Beta1

Assembly

Google.Cloud.SecurityCenter.Settings.V1Beta1.dll

Methods

BatchCalculateEffectiveSettings(BatchCalculateEffectiveSettingsRequest, ServerCallContext)

public virtual Task<BatchCalculateEffectiveSettingsResponse> BatchCalculateEffectiveSettings(BatchCalculateEffectiveSettingsRequest request, ServerCallContext context)

Gets a list of effective settings.

Parameters
NameDescription
requestBatchCalculateEffectiveSettingsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskBatchCalculateEffectiveSettingsResponse

The response to send back to the client (wrapped by a task).

BatchGetSettings(BatchGetSettingsRequest, ServerCallContext)

public virtual Task<BatchGetSettingsResponse> BatchGetSettings(BatchGetSettingsRequest request, ServerCallContext context)

Gets a list of settings.

Parameters
NameDescription
requestBatchGetSettingsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskBatchGetSettingsResponse

The response to send back to the client (wrapped by a task).

CalculateEffectiveComponentSettings(CalculateEffectiveComponentSettingsRequest, ServerCallContext)

public virtual Task<ComponentSettings> CalculateEffectiveComponentSettings(CalculateEffectiveComponentSettingsRequest request, ServerCallContext context)

Gets the Effective Component Settings.

Parameters
NameDescription
requestCalculateEffectiveComponentSettingsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskComponentSettings

The response to send back to the client (wrapped by a task).

CalculateEffectiveSettings(CalculateEffectiveSettingsRequest, ServerCallContext)

public virtual Task<Settings> CalculateEffectiveSettings(CalculateEffectiveSettingsRequest request, ServerCallContext context)

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

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskSettings

The response to send back to the client (wrapped by a task).

GetComponentSettings(GetComponentSettingsRequest, ServerCallContext)

public virtual Task<ComponentSettings> GetComponentSettings(GetComponentSettingsRequest request, ServerCallContext context)

Gets the Component Settings.

Parameters
NameDescription
requestGetComponentSettingsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskComponentSettings

The response to send back to the client (wrapped by a task).

GetServiceAccount(GetServiceAccountRequest, ServerCallContext)

public virtual Task<ServiceAccount> GetServiceAccount(GetServiceAccountRequest request, ServerCallContext context)

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

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskServiceAccount

The response to send back to the client (wrapped by a task).

GetSettings(GetSettingsRequest, ServerCallContext)

public virtual Task<Settings> GetSettings(GetSettingsRequest request, ServerCallContext context)

Gets the Settings.

Parameters
NameDescription
requestGetSettingsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskSettings

The response to send back to the client (wrapped by a task).

ListComponents(ListComponentsRequest, ServerCallContext)

public virtual Task<ListComponentsResponse> ListComponents(ListComponentsRequest request, ServerCallContext context)

Retrieves an unordered list of available SCC components.

Parameters
NameDescription
requestListComponentsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListComponentsResponse

The response to send back to the client (wrapped by a task).

ListDetectors(ListDetectorsRequest, ServerCallContext)

public virtual Task<ListDetectorsResponse> ListDetectors(ListDetectorsRequest request, ServerCallContext context)

Retrieves an unordered list of available detectors.

Parameters
NameDescription
requestListDetectorsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListDetectorsResponse

The response to send back to the client (wrapped by a task).

ResetComponentSettings(ResetComponentSettingsRequest, ServerCallContext)

public virtual Task<Empty> ResetComponentSettings(ResetComponentSettingsRequest request, ServerCallContext context)

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

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

ResetSettings(ResetSettingsRequest, ServerCallContext)

public virtual Task<Empty> ResetSettings(ResetSettingsRequest request, ServerCallContext context)

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

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

UpdateComponentSettings(UpdateComponentSettingsRequest, ServerCallContext)

public virtual Task<ComponentSettings> UpdateComponentSettings(UpdateComponentSettingsRequest request, ServerCallContext context)

Updates the Component Settings.

Parameters
NameDescription
requestUpdateComponentSettingsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskComponentSettings

The response to send back to the client (wrapped by a task).

UpdateSettings(UpdateSettingsRequest, ServerCallContext)

public virtual Task<Settings> UpdateSettings(UpdateSettingsRequest request, ServerCallContext context)

Updates the Settings.

Parameters
NameDescription
requestUpdateSettingsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskSettings

The response to send back to the client (wrapped by a task).