Class Framework (0.3.0) 

public final class Framework extends GeneratedMessageV3 implements FrameworkOrBuilder

A Framework is a collection of CloudControls to address security and compliance requirements. Frameworks can be used for prevention, detection, and auditing. They can be either built-in, industry-standard frameworks provided by GCP/AZURE/AWS (e.g., NIST, FedRAMP) or custom frameworks created by users.

Protobuf type google.cloud.cloudsecuritycompliance.v1.Framework

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Framework

Implements

FrameworkOrBuilder

Static Fields

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_CONTROL_DETAILS_FIELD_NUMBER

public static final int CLOUD_CONTROL_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

MAJOR_REVISION_ID_FIELD_NUMBER

public static final int MAJOR_REVISION_ID_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTED_CLOUD_PROVIDERS_FIELD_NUMBER

public static final int SUPPORTED_CLOUD_PROVIDERS_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTED_ENFORCEMENT_MODES_FIELD_NUMBER

public static final int SUPPORTED_ENFORCEMENT_MODES_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTED_TARGET_RESOURCE_TYPES_FIELD_NUMBER

public static final int SUPPORTED_TARGET_RESOURCE_TYPES_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Framework getDefaultInstance()
Returns
Type Description
Framework

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Framework.Builder newBuilder()
Returns
Type Description
Framework.Builder

newBuilder(Framework prototype)

public static Framework.Builder newBuilder(Framework prototype)
Parameter
Name Description
prototype Framework
Returns
Type Description
Framework.Builder

parseDelimitedFrom(InputStream input)

public static Framework parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Framework
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Framework parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Framework
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Framework parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Framework
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Framework parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Framework
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Framework parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Framework
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Framework parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Framework
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Framework parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Framework
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Framework parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Framework
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Framework parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Framework
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Framework parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Framework
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Framework parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Framework
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Framework parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Framework
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Framework> parser()
Returns
Type Description
Parser<Framework>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCategory(int index)

public FrameworkCategory getCategory(int index)

Optional. The category of the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.FrameworkCategory category = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
FrameworkCategory

The category at the given index.

getCategoryCount()

public int getCategoryCount()

Optional. The category of the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.FrameworkCategory category = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of category.

getCategoryList()

public List<FrameworkCategory> getCategoryList()

Optional. The category of the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.FrameworkCategory category = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<FrameworkCategory>

A list containing the category.

getCategoryValue(int index)

public int getCategoryValue(int index)

Optional. The category of the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.FrameworkCategory category = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of category at the given index.

getCategoryValueList()

public List<Integer> getCategoryValueList()

Optional. The category of the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.FrameworkCategory category = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for category.

getCloudControlDetails(int index)

public CloudControlDetails getCloudControlDetails(int index)

Optional. The details of the cloud controls directly added without any grouping in the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlDetails cloud_control_details = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CloudControlDetails

getCloudControlDetailsCount()

public int getCloudControlDetailsCount()

Optional. The details of the cloud controls directly added without any grouping in the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlDetails cloud_control_details = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCloudControlDetailsList()

public List<CloudControlDetails> getCloudControlDetailsList()

Optional. The details of the cloud controls directly added without any grouping in the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlDetails cloud_control_details = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<CloudControlDetails>

getCloudControlDetailsOrBuilder(int index)

public CloudControlDetailsOrBuilder getCloudControlDetailsOrBuilder(int index)

Optional. The details of the cloud controls directly added without any grouping in the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlDetails cloud_control_details = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CloudControlDetailsOrBuilder

getCloudControlDetailsOrBuilderList()

public List<? extends CloudControlDetailsOrBuilder> getCloudControlDetailsOrBuilderList()

Optional. The details of the cloud controls directly added without any grouping in the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlDetails cloud_control_details = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.cloudsecuritycompliance.v1.CloudControlDetailsOrBuilder>

getDefaultInstanceForType()

public Framework getDefaultInstanceForType()
Returns
Type Description
Framework

getDescription()

public String getDescription()

Optional. The description of the framework. The maximum length is 2000 characters.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the framework. The maximum length is 2000 characters.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Optional. Display name of the framework. The maximum length is 200 characters.

string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Display name of the framework. The maximum length is 200 characters.

string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getMajorRevisionId()

public long getMajorRevisionId()

Output only. Major revision of the framework incremented in ascending order.

int64 major_revision_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The majorRevisionId.

getName()

public String getName()

Required. Identifier. The name of the framework. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Identifier. The name of the framework. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Framework> getParserForType()
Returns
Type Description
Parser<Framework>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSupportedCloudProviders(int index)

public CloudProvider getSupportedCloudProviders(int index)

Output only. cloud providers supported

repeated .google.cloud.cloudsecuritycompliance.v1.CloudProvider supported_cloud_providers = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
CloudProvider

The supportedCloudProviders at the given index.

getSupportedCloudProvidersCount()

public int getSupportedCloudProvidersCount()

Output only. cloud providers supported

repeated .google.cloud.cloudsecuritycompliance.v1.CloudProvider supported_cloud_providers = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of supportedCloudProviders.

getSupportedCloudProvidersList()

public List<CloudProvider> getSupportedCloudProvidersList()

Output only. cloud providers supported

repeated .google.cloud.cloudsecuritycompliance.v1.CloudProvider supported_cloud_providers = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<CloudProvider>

A list containing the supportedCloudProviders.

getSupportedCloudProvidersValue(int index)

public int getSupportedCloudProvidersValue(int index)

Output only. cloud providers supported

repeated .google.cloud.cloudsecuritycompliance.v1.CloudProvider supported_cloud_providers = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of supportedCloudProviders at the given index.

getSupportedCloudProvidersValueList()

public List<Integer> getSupportedCloudProvidersValueList()

Output only. cloud providers supported

repeated .google.cloud.cloudsecuritycompliance.v1.CloudProvider supported_cloud_providers = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for supportedCloudProviders.

getSupportedEnforcementModes(int index)

public EnforcementMode getSupportedEnforcementModes(int index)

Output only. The supported enforcement modes of the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.EnforcementMode supported_enforcement_modes = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
EnforcementMode

The supportedEnforcementModes at the given index.

getSupportedEnforcementModesCount()

public int getSupportedEnforcementModesCount()

Output only. The supported enforcement modes of the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.EnforcementMode supported_enforcement_modes = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of supportedEnforcementModes.

getSupportedEnforcementModesList()

public List<EnforcementMode> getSupportedEnforcementModesList()

Output only. The supported enforcement modes of the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.EnforcementMode supported_enforcement_modes = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<EnforcementMode>

A list containing the supportedEnforcementModes.

getSupportedEnforcementModesValue(int index)

public int getSupportedEnforcementModesValue(int index)

Output only. The supported enforcement modes of the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.EnforcementMode supported_enforcement_modes = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of supportedEnforcementModes at the given index.

getSupportedEnforcementModesValueList()

public List<Integer> getSupportedEnforcementModesValueList()

Output only. The supported enforcement modes of the framework.

repeated .google.cloud.cloudsecuritycompliance.v1.EnforcementMode supported_enforcement_modes = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for supportedEnforcementModes.

getSupportedTargetResourceTypes(int index)

public TargetResourceType getSupportedTargetResourceTypes(int index)

Output only. target resource types supported by the Framework.

repeated .google.cloud.cloudsecuritycompliance.v1.TargetResourceType supported_target_resource_types = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
TargetResourceType

The supportedTargetResourceTypes at the given index.

getSupportedTargetResourceTypesCount()

public int getSupportedTargetResourceTypesCount()

Output only. target resource types supported by the Framework.

repeated .google.cloud.cloudsecuritycompliance.v1.TargetResourceType supported_target_resource_types = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of supportedTargetResourceTypes.

getSupportedTargetResourceTypesList()

public List<TargetResourceType> getSupportedTargetResourceTypesList()

Output only. target resource types supported by the Framework.

repeated .google.cloud.cloudsecuritycompliance.v1.TargetResourceType supported_target_resource_types = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<TargetResourceType>

A list containing the supportedTargetResourceTypes.

getSupportedTargetResourceTypesValue(int index)

public int getSupportedTargetResourceTypesValue(int index)

Output only. target resource types supported by the Framework.

repeated .google.cloud.cloudsecuritycompliance.v1.TargetResourceType supported_target_resource_types = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of supportedTargetResourceTypes at the given index.

getSupportedTargetResourceTypesValueList()

public List<Integer> getSupportedTargetResourceTypesValueList()

Output only. target resource types supported by the Framework.

repeated .google.cloud.cloudsecuritycompliance.v1.TargetResourceType supported_target_resource_types = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for supportedTargetResourceTypes.

getType()

public Framework.FrameworkType getType()

Output only. The type of the framework. The default is TYPE_CUSTOM.

.google.cloud.cloudsecuritycompliance.v1.Framework.FrameworkType type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Framework.FrameworkType

The type.

getTypeValue()

public int getTypeValue()

Output only. The type of the framework. The default is TYPE_CUSTOM.

.google.cloud.cloudsecuritycompliance.v1.Framework.FrameworkType type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for type.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Framework.Builder newBuilderForType()
Returns
Type Description
Framework.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Framework.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Framework.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Framework.Builder toBuilder()
Returns
Type Description
Framework.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException