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

[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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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).