Cloud Security Compliance v1 API - Class ConfigClientImpl (1.0.0-beta04) 

public sealed class ConfigClientImpl : ConfigClient

Reference documentation and code samples for the Cloud Security Compliance v1 API class ConfigClientImpl.

Config client wrapper implementation, for convenient use.

Inheritance

object > ConfigClient > ConfigClientImpl

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Remarks

Config Service manages compliance frameworks, cloud controls, and their configurations.

Constructors

ConfigClientImpl(ConfigClient, ConfigSettings, ILogger)

public ConfigClientImpl(Config.ConfigClient grpcClient, ConfigSettings settings, ILogger logger)

Constructs a client wrapper for the Config service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ConfigConfigClient

The underlying gRPC client.
settings ConfigSettings

The base ConfigSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override Config.ConfigClient GrpcClient { get; }

The underlying gRPC Config client

Property Value
Type Description
ConfigConfigClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

CreateCloudControl(CreateCloudControlRequest, CallSettings)

public override CloudControl CreateCloudControl(CreateCloudControlRequest request, CallSettings callSettings = null)

Creates a custom cloud control in a given parent resource. You can't create built-in cloud controls because those are managed by Google.

Parameters
Name Description
request CreateCloudControlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CloudControl

The RPC response.
Overrides

CreateCloudControlAsync(CreateCloudControlRequest, CallSettings)

public override Task<CloudControl> CreateCloudControlAsync(CreateCloudControlRequest request, CallSettings callSettings = null)

Creates a custom cloud control in a given parent resource. You can't create built-in cloud controls because those are managed by Google.

Parameters
Name Description
request CreateCloudControlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCloudControl

A Task containing the RPC response.
Overrides

CreateFramework(CreateFrameworkRequest, CallSettings)

public override Framework CreateFramework(CreateFrameworkRequest request, CallSettings callSettings = null)

Creates a custom framework in a given parent resource. You can't create built-in frameworks because those are managed by Google.

Parameters
Name Description
request CreateFrameworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Framework

The RPC response.
Overrides

CreateFrameworkAsync(CreateFrameworkRequest, CallSettings)

public override Task<Framework> CreateFrameworkAsync(CreateFrameworkRequest request, CallSettings callSettings = null)

Creates a custom framework in a given parent resource. You can't create built-in frameworks because those are managed by Google.

Parameters
Name Description
request CreateFrameworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFramework

A Task containing the RPC response.
Overrides

DeleteCloudControl(DeleteCloudControlRequest, CallSettings)

public override void DeleteCloudControl(DeleteCloudControlRequest request, CallSettings callSettings = null)

Deletes a custom cloud control, including all its major and minor revisions. Consider the following:

  • You can't delete built-in cloud controls. You can only delete cloud controls with type CUSTOM.
  • You can't delete cloud controls if any of the versions are referenced by a framework.
  • You can't restore a deleted cloud control. This action is permanent.
Parameters
Name Description
request DeleteCloudControlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteCloudControlAsync(DeleteCloudControlRequest, CallSettings)

public override Task DeleteCloudControlAsync(DeleteCloudControlRequest request, CallSettings callSettings = null)

Deletes a custom cloud control, including all its major and minor revisions. Consider the following:

  • You can't delete built-in cloud controls. You can only delete cloud controls with type CUSTOM.
  • You can't delete cloud controls if any of the versions are referenced by a framework.
  • You can't restore a deleted cloud control. This action is permanent.
Parameters
Name Description
request DeleteCloudControlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteFramework(DeleteFrameworkRequest, CallSettings)

public override void DeleteFramework(DeleteFrameworkRequest request, CallSettings callSettings = null)

Deletes a custom framework, including all its major and minor revisions. Consider the following:

  • You can't delete built-in frameworks. You can only delete frameworks with type CUSTOM.
  • You can't delete frameworks that are deployed to a resource.
  • You can't restore a deleted framework. This action is permanent.
Parameters
Name Description
request DeleteFrameworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteFrameworkAsync(DeleteFrameworkRequest, CallSettings)

public override Task DeleteFrameworkAsync(DeleteFrameworkRequest request, CallSettings callSettings = null)

Deletes a custom framework, including all its major and minor revisions. Consider the following:

  • You can't delete built-in frameworks. You can only delete frameworks with type CUSTOM.
  • You can't delete frameworks that are deployed to a resource.
  • You can't restore a deleted framework. This action is permanent.
Parameters
Name Description
request DeleteFrameworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

GetCloudControl(GetCloudControlRequest, CallSettings)

public override CloudControl GetCloudControl(GetCloudControlRequest request, CallSettings callSettings = null)

Gets details about a cloud control. This method retrieves the latest major version of a cloud control that you identify by name.

By default, the latest major version of the cloud control is returned. To retrieve a specific major version, include major_revision_id in the request.

Parameters
Name Description
request GetCloudControlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CloudControl

The RPC response.
Overrides

GetCloudControlAsync(GetCloudControlRequest, CallSettings)

public override Task<CloudControl> GetCloudControlAsync(GetCloudControlRequest request, CallSettings callSettings = null)

Gets details about a cloud control. This method retrieves the latest major version of a cloud control that you identify by name.

By default, the latest major version of the cloud control is returned. To retrieve a specific major version, include major_revision_id in the request.

Parameters
Name Description
request GetCloudControlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCloudControl

A Task containing the RPC response.
Overrides

GetFramework(GetFrameworkRequest, CallSettings)

public override Framework GetFramework(GetFrameworkRequest request, CallSettings callSettings = null)

Gets details about a framework. This method retrieves the latest major version of the framework.

To retrieve a specific major version, include major_revision_id in the request.

Parameters
Name Description
request GetFrameworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Framework

The RPC response.
Overrides

GetFrameworkAsync(GetFrameworkRequest, CallSettings)

public override Task<Framework> GetFrameworkAsync(GetFrameworkRequest request, CallSettings callSettings = null)

Gets details about a framework. This method retrieves the latest major version of the framework.

To retrieve a specific major version, include major_revision_id in the request.

Parameters
Name Description
request GetFrameworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFramework

A Task containing the RPC response.
Overrides

ListCloudControls(ListCloudControlsRequest, CallSettings)

public override PagedEnumerable<ListCloudControlsResponse, CloudControl> ListCloudControls(ListCloudControlsRequest request, CallSettings callSettings = null)

Lists the cloud controls (both built-in and custom) that are available in a given parent resource. The latest major version of each cloud control is returned. This method supports pagination.

Parameters
Name Description
request ListCloudControlsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListCloudControlsResponseCloudControl

A pageable sequence of CloudControl resources.
Overrides

ListCloudControlsAsync(ListCloudControlsRequest, CallSettings)

public override PagedAsyncEnumerable<ListCloudControlsResponse, CloudControl> ListCloudControlsAsync(ListCloudControlsRequest request, CallSettings callSettings = null)

Lists the cloud controls (both built-in and custom) that are available in a given parent resource. The latest major version of each cloud control is returned. This method supports pagination.

Parameters
Name Description
request ListCloudControlsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListCloudControlsResponseCloudControl

A pageable asynchronous sequence of CloudControl resources.
Overrides

ListFrameworks(ListFrameworksRequest, CallSettings)

public override PagedEnumerable<ListFrameworksResponse, Framework> ListFrameworks(ListFrameworksRequest request, CallSettings callSettings = null)

Lists the frameworks (both built-in and custom) that are available within the parent resource. The latest major version of each framework is returned. This method supports pagination.

Parameters
Name Description
request ListFrameworksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListFrameworksResponseFramework

A pageable sequence of Framework resources.
Overrides

ListFrameworksAsync(ListFrameworksRequest, CallSettings)

public override PagedAsyncEnumerable<ListFrameworksResponse, Framework> ListFrameworksAsync(ListFrameworksRequest request, CallSettings callSettings = null)

Lists the frameworks (both built-in and custom) that are available within the parent resource. The latest major version of each framework is returned. This method supports pagination.

Parameters
Name Description
request ListFrameworksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListFrameworksResponseFramework

A pageable asynchronous sequence of Framework resources.
Overrides

UpdateCloudControl(UpdateCloudControlRequest, CallSettings)

public override CloudControl UpdateCloudControl(UpdateCloudControlRequest request, CallSettings callSettings = null)

Updates a custom cloud control. This method allows for partial updates of a cloud control. Use the update_mask to specify which fields to update. Consider the following:

  • If you provide an update_mask, only the fields that are specified in the mask are updated.
  • If you don't provide an update_mask, all the fields that are present in the request's cloud_control body are used to overwrite the existing resource.

You can only update cloud controls with the CUSTOM type. A successful update creates a new version of the cloud control.

Parameters
Name Description
request UpdateCloudControlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CloudControl

The RPC response.
Overrides

UpdateCloudControlAsync(UpdateCloudControlRequest, CallSettings)

public override Task<CloudControl> UpdateCloudControlAsync(UpdateCloudControlRequest request, CallSettings callSettings = null)

Updates a custom cloud control. This method allows for partial updates of a cloud control. Use the update_mask to specify which fields to update. Consider the following:

  • If you provide an update_mask, only the fields that are specified in the mask are updated.
  • If you don't provide an update_mask, all the fields that are present in the request's cloud_control body are used to overwrite the existing resource.

You can only update cloud controls with the CUSTOM type. A successful update creates a new version of the cloud control.

Parameters
Name Description
request UpdateCloudControlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCloudControl

A Task containing the RPC response.
Overrides

UpdateFramework(UpdateFrameworkRequest, CallSettings)

public override Framework UpdateFramework(UpdateFrameworkRequest request, CallSettings callSettings = null)

Updates a custom framework. This method allows for partial updates of a framework. Use the update_mask to specify which fields to update. Consider the following:

  • If you provide an update_mask, only the fields that are specified in the mask are updated.
  • If you don't provide an update_mask, all the fields that are present in the request's framework body are used to overwrite the existing resource.

You can only update frameworks with the CUSTOM type. A successful update creates a new version of the framework.

Parameters
Name Description
request UpdateFrameworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Framework

The RPC response.
Overrides

UpdateFrameworkAsync(UpdateFrameworkRequest, CallSettings)

public override Task<Framework> UpdateFrameworkAsync(UpdateFrameworkRequest request, CallSettings callSettings = null)

Updates a custom framework. This method allows for partial updates of a framework. Use the update_mask to specify which fields to update. Consider the following:

  • If you provide an update_mask, only the fields that are specified in the mask are updated.
  • If you don't provide an update_mask, all the fields that are present in the request's framework body are used to overwrite the existing resource.

You can only update frameworks with the CUSTOM type. A successful update creates a new version of the framework.

Parameters
Name Description
request UpdateFrameworkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFramework

A Task containing the RPC response.
Overrides