Class SecurityMarks

public final class SecurityMarks extends GeneratedMessageV3 implements SecurityMarksOrBuilder

User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.

Protobuf type google.cloud.securitycenter.v1.SecurityMarks

Static Fields

CANONICAL_NAME_FIELD_NUMBER

public static final int CANONICAL_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

MARKS_FIELD_NUMBER

public static final int MARKS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SecurityMarks getDefaultInstance()
Returns
TypeDescription
SecurityMarks

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SecurityMarks.Builder newBuilder()
Returns
TypeDescription
SecurityMarks.Builder

newBuilder(SecurityMarks prototype)

public static SecurityMarks.Builder newBuilder(SecurityMarks prototype)
Parameter
NameDescription
prototypeSecurityMarks
Returns
TypeDescription
SecurityMarks.Builder

parseDelimitedFrom(InputStream input)

public static SecurityMarks parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityMarks parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SecurityMarks parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecurityMarks parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecurityMarks parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecurityMarks parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecurityMarks parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityMarks parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SecurityMarks parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityMarks parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SecurityMarks parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecurityMarks parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecurityMarks
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SecurityMarks> parser()
Returns
TypeDescription
Parser<SecurityMarks>

Methods

containsMarks(String key)

public boolean containsMarks(String key)

Mutable user specified security marks belonging to the parent resource. Constraints are as follows:

  • Keys and values are treated as case insensitive
  • Keys must be between 1 - 256 characters (inclusive)
  • Keys must be letters, numbers, underscores, or dashes
  • Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)

map<string, string> marks = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCanonicalName()

public String getCanonicalName()

The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"

string canonical_name = 3;

Returns
TypeDescription
String

The canonicalName.

getCanonicalNameBytes()

public ByteString getCanonicalNameBytes()

The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"

string canonical_name = 3;

Returns
TypeDescription
ByteString

The bytes for canonicalName.

getDefaultInstanceForType()

public SecurityMarks getDefaultInstanceForType()
Returns
TypeDescription
SecurityMarks

getMarks()

public Map<String,String> getMarks()

Use #getMarksMap() instead.

Returns
TypeDescription
Map<String,String>

getMarksCount()

public int getMarksCount()

Mutable user specified security marks belonging to the parent resource. Constraints are as follows:

  • Keys and values are treated as case insensitive
  • Keys must be between 1 - 256 characters (inclusive)
  • Keys must be letters, numbers, underscores, or dashes
  • Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)

map<string, string> marks = 2;

Returns
TypeDescription
int

getMarksMap()

public Map<String,String> getMarksMap()

Mutable user specified security marks belonging to the parent resource. Constraints are as follows:

  • Keys and values are treated as case insensitive
  • Keys must be between 1 - 256 characters (inclusive)
  • Keys must be letters, numbers, underscores, or dashes
  • Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)

map<string, string> marks = 2;

Returns
TypeDescription
Map<String,String>

getMarksOrDefault(String key, String defaultValue)

public String getMarksOrDefault(String key, String defaultValue)

Mutable user specified security marks belonging to the parent resource. Constraints are as follows:

  • Keys and values are treated as case insensitive
  • Keys must be between 1 - 256 characters (inclusive)
  • Keys must be letters, numbers, underscores, or dashes
  • Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)

map<string, string> marks = 2;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getMarksOrThrow(String key)

public String getMarksOrThrow(String key)

Mutable user specified security marks belonging to the parent resource. Constraints are as follows:

  • Keys and values are treated as case insensitive
  • Keys must be between 1 - 256 characters (inclusive)
  • Keys must be letters, numbers, underscores, or dashes
  • Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)

map<string, string> marks = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<SecurityMarks> getParserForType()
Returns
TypeDescription
Parser<SecurityMarks>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SecurityMarks.Builder newBuilderForType()
Returns
TypeDescription
SecurityMarks.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecurityMarks.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SecurityMarks.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SecurityMarks.Builder toBuilder()
Returns
TypeDescription
SecurityMarks.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException