Class ConfigGrpc.ConfigBlockingV2Stub (0.7.0)

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

A stub to allow clients to do 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.ConfigBlockingV2Stub

Methods

build(Channel channel, CallOptions callOptions)

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

createCloudControl(CreateCloudControlRequest request)

public CloudControl createCloudControl(CreateCloudControlRequest request)

Creates a custom cloud control in a given parent resource. You can't create built-in cloud controls because those are managed by Google.

Parameter
Name Description
request CreateCloudControlRequest
Returns
Type Description
CloudControl
Exceptions
Type Description
io.grpc.StatusException

createFramework(CreateFrameworkRequest request)

public Framework createFramework(CreateFrameworkRequest request)

Creates a custom framework in a given parent resource. You can't create built-in frameworks because those are managed by Google.

Parameter
Name Description
request CreateFrameworkRequest
Returns
Type Description
Framework
Exceptions
Type Description
io.grpc.StatusException

deleteCloudControl(DeleteCloudControlRequest request)

public Empty deleteCloudControl(DeleteCloudControlRequest request)

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

deleteFramework(DeleteFrameworkRequest request)

public Empty deleteFramework(DeleteFrameworkRequest request)

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

getCloudControl(GetCloudControlRequest request)

public CloudControl getCloudControl(GetCloudControlRequest request)

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.

Parameter
Name Description
request GetCloudControlRequest
Returns
Type Description
CloudControl
Exceptions
Type Description
io.grpc.StatusException

getFramework(GetFrameworkRequest request)

public Framework getFramework(GetFrameworkRequest request)

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.

Parameter
Name Description
request GetFrameworkRequest
Returns
Type Description
Framework
Exceptions
Type Description
io.grpc.StatusException

listCloudControls(ListCloudControlsRequest request)

public ListCloudControlsResponse listCloudControls(ListCloudControlsRequest request)

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.

Parameter
Name Description
request ListCloudControlsRequest
Returns
Type Description
ListCloudControlsResponse
Exceptions
Type Description
io.grpc.StatusException

listFrameworks(ListFrameworksRequest request)

public ListFrameworksResponse listFrameworks(ListFrameworksRequest request)

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.

Parameter
Name Description
request ListFrameworksRequest
Returns
Type Description
ListFrameworksResponse
Exceptions
Type Description
io.grpc.StatusException

updateCloudControl(UpdateCloudControlRequest request)

public CloudControl updateCloudControl(UpdateCloudControlRequest request)

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

updateFramework(UpdateFrameworkRequest request)

public Framework updateFramework(UpdateFrameworkRequest request)

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