Interface ConfigGrpc.AsyncService (0.2.0)

public static interface ConfigGrpc.AsyncService

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

Methods

createCloudControl(CreateCloudControlRequest request, StreamObserver<CloudControl> responseObserver)

public default void createCloudControl(CreateCloudControlRequest request, StreamObserver<CloudControl> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<CloudControl>

createFramework(CreateFrameworkRequest request, StreamObserver<Framework> responseObserver)

public default void createFramework(CreateFrameworkRequest request, StreamObserver<Framework> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Framework>

deleteCloudControl(DeleteCloudControlRequest request, StreamObserver<Empty> responseObserver)

public default void deleteCloudControl(DeleteCloudControlRequest request, StreamObserver<Empty> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteFramework(DeleteFrameworkRequest request, StreamObserver<Empty> responseObserver)

public default void deleteFramework(DeleteFrameworkRequest request, StreamObserver<Empty> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Empty>

getCloudControl(GetCloudControlRequest request, StreamObserver<CloudControl> responseObserver)

public default void getCloudControl(GetCloudControlRequest request, StreamObserver<CloudControl> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<CloudControl>

getFramework(GetFrameworkRequest request, StreamObserver<Framework> responseObserver)

public default void getFramework(GetFrameworkRequest request, StreamObserver<Framework> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Framework>

listCloudControls(ListCloudControlsRequest request, StreamObserver<ListCloudControlsResponse> responseObserver)

public default void listCloudControls(ListCloudControlsRequest request, StreamObserver<ListCloudControlsResponse> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<ListCloudControlsResponse>

listFrameworks(ListFrameworksRequest request, StreamObserver<ListFrameworksResponse> responseObserver)

public default void listFrameworks(ListFrameworksRequest request, StreamObserver<ListFrameworksResponse> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<ListFrameworksResponse>

updateCloudControl(UpdateCloudControlRequest request, StreamObserver<CloudControl> responseObserver)

public default void updateCloudControl(UpdateCloudControlRequest request, StreamObserver<CloudControl> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<CloudControl>

updateFramework(UpdateFrameworkRequest request, StreamObserver<Framework> responseObserver)

public default void updateFramework(UpdateFrameworkRequest request, StreamObserver<Framework> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Framework>