Class ConfigGrpc.ConfigBlockingStub (0.2.0)

public static final class ConfigGrpc.ConfigBlockingStub extends AbstractBlockingStub<ConfigGrpc.ConfigBlockingStub>

A stub to allow clients to do limited synchronous rpc calls to service Config.

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > ConfigGrpc.ConfigBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected ConfigGrpc.ConfigBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
ConfigGrpc.ConfigBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createCloudControl(CreateCloudControlRequest request)

public CloudControl createCloudControl(CreateCloudControlRequest request)

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.

Parameter
Name Description
request CreateCloudControlRequest
Returns
Type Description
CloudControl

createFramework(CreateFrameworkRequest request)

public Framework createFramework(CreateFrameworkRequest request)

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.

Parameter
Name Description
request CreateFrameworkRequest
Returns
Type Description
Framework

deleteCloudControl(DeleteCloudControlRequest request)

public Empty deleteCloudControl(DeleteCloudControlRequest request)

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.
Parameter
Name Description
request DeleteCloudControlRequest
Returns
Type Description
Empty

deleteFramework(DeleteFrameworkRequest request)

public Empty deleteFramework(DeleteFrameworkRequest request)

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.
Parameter
Name Description
request DeleteFrameworkRequest
Returns
Type Description
Empty

getCloudControl(GetCloudControlRequest request)

public CloudControl getCloudControl(GetCloudControlRequest request)

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.

Parameter
Name Description
request GetCloudControlRequest
Returns
Type Description
CloudControl

getFramework(GetFrameworkRequest request)

public Framework getFramework(GetFrameworkRequest request)

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.

Parameter
Name Description
request GetFrameworkRequest
Returns
Type Description
Framework

listCloudControls(ListCloudControlsRequest request)

public ListCloudControlsResponse listCloudControls(ListCloudControlsRequest request)

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.

Parameter
Name Description
request ListCloudControlsRequest
Returns
Type Description
ListCloudControlsResponse

listFrameworks(ListFrameworksRequest request)

public ListFrameworksResponse listFrameworks(ListFrameworksRequest request)

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.

Parameter
Name Description
request ListFrameworksRequest
Returns
Type Description
ListFrameworksResponse

updateCloudControl(UpdateCloudControlRequest request)

public CloudControl updateCloudControl(UpdateCloudControlRequest request)

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.
Parameter
Name Description
request UpdateCloudControlRequest
Returns
Type Description
CloudControl

updateFramework(UpdateFrameworkRequest request)

public Framework updateFramework(UpdateFrameworkRequest request)

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.
Parameter
Name Description
request UpdateFrameworkRequest
Returns
Type Description
Framework