Cloud Security Compliance v1 API - Class Config.ConfigBase (1.0.0-beta02)

[BindServiceMethod(typeof(Config), "BindService")]
public abstract class Config.ConfigBase

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

Base class for server-side implementations of Config

Inheritance

object > Config.ConfigBase

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Methods

CreateCloudControl(CreateCloudControlRequest, ServerCallContext)

public virtual Task<CloudControl> CreateCloudControl(CreateCloudControlRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

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

Returns
Type Description
TaskCloudControl

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

CreateFramework(CreateFrameworkRequest, ServerCallContext)

public virtual Task<Framework> CreateFramework(CreateFrameworkRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

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

Returns
Type Description
TaskFramework

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

DeleteCloudControl(DeleteCloudControlRequest, ServerCallContext)

public virtual Task<Empty> DeleteCloudControl(DeleteCloudControlRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

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

Returns
Type Description
TaskEmpty

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

DeleteFramework(DeleteFrameworkRequest, ServerCallContext)

public virtual Task<Empty> DeleteFramework(DeleteFrameworkRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

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

Returns
Type Description
TaskEmpty

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

GetCloudControl(GetCloudControlRequest, ServerCallContext)

public virtual Task<CloudControl> GetCloudControl(GetCloudControlRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

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

Returns
Type Description
TaskCloudControl

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

GetFramework(GetFrameworkRequest, ServerCallContext)

public virtual Task<Framework> GetFramework(GetFrameworkRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

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

Returns
Type Description
TaskFramework

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

ListCloudControls(ListCloudControlsRequest, ServerCallContext)

public virtual Task<ListCloudControlsResponse> ListCloudControls(ListCloudControlsRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

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

Returns
Type Description
TaskListCloudControlsResponse

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

ListFrameworks(ListFrameworksRequest, ServerCallContext)

public virtual Task<ListFrameworksResponse> ListFrameworks(ListFrameworksRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

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

Returns
Type Description
TaskListFrameworksResponse

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

UpdateCloudControl(UpdateCloudControlRequest, ServerCallContext)

public virtual Task<CloudControl> UpdateCloudControl(UpdateCloudControlRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

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

Returns
Type Description
TaskCloudControl

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

UpdateFramework(UpdateFrameworkRequest, ServerCallContext)

public virtual Task<Framework> UpdateFramework(UpdateFrameworkRequest request, ServerCallContext context)

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 received from the client.

context ServerCallContext

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

Returns
Type Description
TaskFramework

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