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

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 new CloudControl with type Custom under a given parent resource. Built-in CloudControls are managed by Google and cannot be created through this API.

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 new CloudControl with type Custom under a given parent resource. Built-in CloudControls are managed by Google and cannot be created through this API.

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 new Framework with type Custom under a given parent resource. Frameworks with type Built-in are managed by Google and cannot be created through this API.

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 new Framework with type Custom under a given parent resource. Frameworks with type Built-in are managed by Google and cannot be created through this API.

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 single Custom CloudControl, including all its major and minor revisions.

  • This operation can only be performed on CloudControls with type CUSTOM. Built-in CloudControls cannot be deleted.
  • The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
  • This action is permanent and cannot be undone.
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 single Custom CloudControl, including all its major and minor revisions.

  • This operation can only be performed on CloudControls with type CUSTOM. Built-in CloudControls cannot be deleted.
  • The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
  • This action is permanent and cannot be undone.
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 single Custom Framework, including all its minor and minor revisions.

  • This operation can only be performed on Frameworks with type CUSTOM. Built-in Frameworks cannot be deleted.
  • The Framework cannot be deleted if it is currently deployed on any resource.
  • This action is permanent and cannot be undone.
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 single Custom Framework, including all its minor and minor revisions.

  • This operation can only be performed on Frameworks with type CUSTOM. Built-in Frameworks cannot be deleted.
  • The Framework cannot be deleted if it is currently deployed on any resource.
  • This action is permanent and cannot be undone.
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 of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.

By default, the latest major version of the CloudControl is returned. A specific major version can be retrieved by specifying the 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 of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.

By default, the latest major version of the CloudControl is returned. A specific major version can be retrieved by specifying the 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 of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.

By default, the latest major version of the Framework is returned. A specific major version can be retrieved by specifying the 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 of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.

By default, the latest major version of the Framework is returned. A specific major version can be retrieved by specifying the 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 all CloudControls (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each CloudControl is returned.

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 all CloudControls (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each CloudControl is returned.

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 all Frameworks (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each Framework is returned.

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 all Frameworks (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each Framework is returned.

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 single CloudControl. This method allows for partial updates of a Custom CloudControl resource. Built-in CloudControls cannot be updated.

  • If an update_mask is provided, only the fields specified in the mask will be updated.
  • If no update_mask is provided, all fields present in the request's cloud_control body will be used to overwrite the existing resource.

A successful update will result in a new version of the CloudControl.

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 single CloudControl. This method allows for partial updates of a Custom CloudControl resource. Built-in CloudControls cannot be updated.

  • If an update_mask is provided, only the fields specified in the mask will be updated.
  • If no update_mask is provided, all fields present in the request's cloud_control body will be used to overwrite the existing resource.

A successful update will result in a new version of the CloudControl.

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 single Framework. This method allows for partial updates of a Framework resource. The fields to be updated are specified using the update_mask.

  • If an update_mask is provided, only the fields specified in the mask will be updated.
  • If no update_mask is provided, all fields present in the request's framework body will be used to overwrite the existing resource.

This operation can only be performed on Frameworks with type CUSTOM. A successful update will result in 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 single Framework. This method allows for partial updates of a Framework resource. The fields to be updated are specified using the update_mask.

  • If an update_mask is provided, only the fields specified in the mask will be updated.
  • If no update_mask is provided, all fields present in the request's framework body will be used to overwrite the existing resource.

This operation can only be performed on Frameworks with type CUSTOM. A successful update will result in 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