public sealed class SecurityCenterSettingsServiceClientImpl : SecurityCenterSettingsServiceClientSecurityCenterSettingsService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.SecurityCenter.Settings.V1Beta1Assembly
Google.Cloud.SecurityCenter.Settings.V1Beta1.dll
Remarks
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.
Constructors
SecurityCenterSettingsServiceClientImpl(SecurityCenterSettingsService.SecurityCenterSettingsServiceClient, SecurityCenterSettingsServiceSettings)
public SecurityCenterSettingsServiceClientImpl(SecurityCenterSettingsService.SecurityCenterSettingsServiceClient grpcClient, SecurityCenterSettingsServiceSettings settings)Constructs a client wrapper for the SecurityCenterSettingsService service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | SecurityCenterSettingsService.SecurityCenterSettingsServiceClientThe underlying gRPC client. |
settings | SecurityCenterSettingsServiceSettingsThe base SecurityCenterSettingsServiceSettings used within this client. |
Properties
GrpcClient
public override SecurityCenterSettingsService.SecurityCenterSettingsServiceClient GrpcClient { get; }The underlying gRPC SecurityCenterSettingsService client
| Property Value | |
|---|---|
| Type | Description |
SecurityCenterSettingsService.SecurityCenterSettingsServiceClient | |
Methods
BatchCalculateEffectiveSettings(BatchCalculateEffectiveSettingsRequest, CallSettings)
public override BatchCalculateEffectiveSettingsResponse BatchCalculateEffectiveSettings(BatchCalculateEffectiveSettingsRequest request, CallSettings callSettings = null)Gets a list of effective settings.
| Parameters | |
|---|---|
| Name | Description |
request | BatchCalculateEffectiveSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
BatchCalculateEffectiveSettingsResponse | The RPC response. |
BatchCalculateEffectiveSettingsAsync(BatchCalculateEffectiveSettingsRequest, CallSettings)
public override Task<BatchCalculateEffectiveSettingsResponse> BatchCalculateEffectiveSettingsAsync(BatchCalculateEffectiveSettingsRequest request, CallSettings callSettings = null)Gets a list of effective settings.
| Parameters | |
|---|---|
| Name | Description |
request | BatchCalculateEffectiveSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<BatchCalculateEffectiveSettingsResponse> | A Task containing the RPC response. |
BatchGetSettings(BatchGetSettingsRequest, CallSettings)
public override BatchGetSettingsResponse BatchGetSettings(BatchGetSettingsRequest request, CallSettings callSettings = null)Gets a list of settings.
| Parameters | |
|---|---|
| Name | Description |
request | BatchGetSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
BatchGetSettingsResponse | The RPC response. |
BatchGetSettingsAsync(BatchGetSettingsRequest, CallSettings)
public override Task<BatchGetSettingsResponse> BatchGetSettingsAsync(BatchGetSettingsRequest request, CallSettings callSettings = null)Gets a list of settings.
| Parameters | |
|---|---|
| Name | Description |
request | BatchGetSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<BatchGetSettingsResponse> | A Task containing the RPC response. |
CalculateEffectiveComponentSettings(CalculateEffectiveComponentSettingsRequest, CallSettings)
public override ComponentSettings CalculateEffectiveComponentSettings(CalculateEffectiveComponentSettingsRequest request, CallSettings callSettings = null)Gets the Effective Component Settings.
| Parameters | |
|---|---|
| Name | Description |
request | CalculateEffectiveComponentSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ComponentSettings | The RPC response. |
CalculateEffectiveComponentSettingsAsync(CalculateEffectiveComponentSettingsRequest, CallSettings)
public override Task<ComponentSettings> CalculateEffectiveComponentSettingsAsync(CalculateEffectiveComponentSettingsRequest request, CallSettings callSettings = null)Gets the Effective Component Settings.
| Parameters | |
|---|---|
| Name | Description |
request | CalculateEffectiveComponentSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ComponentSettings> | A Task containing the RPC response. |
CalculateEffectiveSettings(CalculateEffectiveSettingsRequest, CallSettings)
public override Settings CalculateEffectiveSettings(CalculateEffectiveSettingsRequest request, CallSettings callSettings = null)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 | |
|---|---|
| Name | Description |
request | CalculateEffectiveSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Settings | The RPC response. |
CalculateEffectiveSettingsAsync(CalculateEffectiveSettingsRequest, CallSettings)
public override Task<Settings> CalculateEffectiveSettingsAsync(CalculateEffectiveSettingsRequest request, CallSettings callSettings = null)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 | |
|---|---|
| Name | Description |
request | CalculateEffectiveSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Settings> | A Task containing the RPC response. |
GetComponentSettings(GetComponentSettingsRequest, CallSettings)
public override ComponentSettings GetComponentSettings(GetComponentSettingsRequest request, CallSettings callSettings = null)Gets the Component Settings.
| Parameters | |
|---|---|
| Name | Description |
request | GetComponentSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ComponentSettings | The RPC response. |
GetComponentSettingsAsync(GetComponentSettingsRequest, CallSettings)
public override Task<ComponentSettings> GetComponentSettingsAsync(GetComponentSettingsRequest request, CallSettings callSettings = null)Gets the Component Settings.
| Parameters | |
|---|---|
| Name | Description |
request | GetComponentSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ComponentSettings> | A Task containing the RPC response. |
GetServiceAccount(GetServiceAccountRequest, CallSettings)
public override ServiceAccount GetServiceAccount(GetServiceAccountRequest request, CallSettings callSettings = null)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 | |
|---|---|
| Name | Description |
request | GetServiceAccountRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ServiceAccount | The RPC response. |
GetServiceAccountAsync(GetServiceAccountRequest, CallSettings)
public override Task<ServiceAccount> GetServiceAccountAsync(GetServiceAccountRequest request, CallSettings callSettings = null)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 | |
|---|---|
| Name | Description |
request | GetServiceAccountRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ServiceAccount> | A Task containing the RPC response. |
GetSettings(GetSettingsRequest, CallSettings)
public override Settings GetSettings(GetSettingsRequest request, CallSettings callSettings = null)Gets the Settings.
| Parameters | |
|---|---|
| Name | Description |
request | GetSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Settings | The RPC response. |
GetSettingsAsync(GetSettingsRequest, CallSettings)
public override Task<Settings> GetSettingsAsync(GetSettingsRequest request, CallSettings callSettings = null)Gets the Settings.
| Parameters | |
|---|---|
| Name | Description |
request | GetSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Settings> | A Task containing the RPC response. |
ListComponents(ListComponentsRequest, CallSettings)
public override PagedEnumerable<ListComponentsResponse, string> ListComponents(ListComponentsRequest request, CallSettings callSettings = null)Retrieves an unordered list of available SCC components.
| Parameters | |
|---|---|
| Name | Description |
request | ListComponentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListComponentsResponse, String> | A pageable sequence of String resources. |
ListComponentsAsync(ListComponentsRequest, CallSettings)
public override PagedAsyncEnumerable<ListComponentsResponse, string> ListComponentsAsync(ListComponentsRequest request, CallSettings callSettings = null)Retrieves an unordered list of available SCC components.
| Parameters | |
|---|---|
| Name | Description |
request | ListComponentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListComponentsResponse, String> | A pageable asynchronous sequence of String resources. |
ListDetectors(ListDetectorsRequest, CallSettings)
public override PagedEnumerable<ListDetectorsResponse, Detector> ListDetectors(ListDetectorsRequest request, CallSettings callSettings = null)Retrieves an unordered list of available detectors.
| Parameters | |
|---|---|
| Name | Description |
request | ListDetectorsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListDetectorsResponse, Detector> | A pageable sequence of Detector resources. |
ListDetectorsAsync(ListDetectorsRequest, CallSettings)
public override PagedAsyncEnumerable<ListDetectorsResponse, Detector> ListDetectorsAsync(ListDetectorsRequest request, CallSettings callSettings = null)Retrieves an unordered list of available detectors.
| Parameters | |
|---|---|
| Name | Description |
request | ListDetectorsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListDetectorsResponse, Detector> | A pageable asynchronous sequence of Detector resources. |
ResetComponentSettings(ResetComponentSettingsRequest, CallSettings)
public override void ResetComponentSettings(ResetComponentSettingsRequest request, CallSettings callSettings = null)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 | |
|---|---|
| Name | Description |
request | ResetComponentSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
ResetComponentSettingsAsync(ResetComponentSettingsRequest, CallSettings)
public override Task ResetComponentSettingsAsync(ResetComponentSettingsRequest request, CallSettings callSettings = null)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 | |
|---|---|
| Name | Description |
request | ResetComponentSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
ResetSettings(ResetSettingsRequest, CallSettings)
public override void ResetSettings(ResetSettingsRequest request, CallSettings callSettings = null)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 | |
|---|---|
| Name | Description |
request | ResetSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
ResetSettingsAsync(ResetSettingsRequest, CallSettings)
public override Task ResetSettingsAsync(ResetSettingsRequest request, CallSettings callSettings = null)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 | |
|---|---|
| Name | Description |
request | ResetSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
UpdateComponentSettings(UpdateComponentSettingsRequest, CallSettings)
public override ComponentSettings UpdateComponentSettings(UpdateComponentSettingsRequest request, CallSettings callSettings = null)Updates the Component Settings.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateComponentSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ComponentSettings | The RPC response. |
UpdateComponentSettingsAsync(UpdateComponentSettingsRequest, CallSettings)
public override Task<ComponentSettings> UpdateComponentSettingsAsync(UpdateComponentSettingsRequest request, CallSettings callSettings = null)Updates the Component Settings.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateComponentSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ComponentSettings> | A Task containing the RPC response. |
UpdateSettings(UpdateSettingsRequest, CallSettings)
public override Settings UpdateSettings(UpdateSettingsRequest request, CallSettings callSettings = null)Updates the Settings.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Settings | The RPC response. |
UpdateSettingsAsync(UpdateSettingsRequest, CallSettings)
public override Task<Settings> UpdateSettingsAsync(UpdateSettingsRequest request, CallSettings callSettings = null)Updates the Settings.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Settings> | A Task containing the RPC response. |