Class Rule (0.1.0)

public final class Rule extends GeneratedMessage implements RuleOrBuilder

A rule to be evaluated.

Protobuf type google.cloud.workloadmanager.v1.Rule

Implements

RuleOrBuilder

Static Fields

ASSET_TYPE_FIELD_NUMBER

public static final int ASSET_TYPE_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

ERROR_MESSAGE_FIELD_NUMBER

public static final int ERROR_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRIMARY_CATEGORY_FIELD_NUMBER

public static final int PRIMARY_CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

REMEDIATION_FIELD_NUMBER

public static final int REMEDIATION_FIELD_NUMBER
Field Value
Type Description
int

REVISION_ID_FIELD_NUMBER

public static final int REVISION_ID_FIELD_NUMBER
Field Value
Type Description
int

RULE_TYPE_FIELD_NUMBER

public static final int RULE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SECONDARY_CATEGORY_FIELD_NUMBER

public static final int SECONDARY_CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

SEVERITY_FIELD_NUMBER

public static final int SEVERITY_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Rule getDefaultInstance()
Returns
Type Description
Rule

getDescriptor()

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

newBuilder()

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

newBuilder(Rule prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAssetType()

public String getAssetType()

The CAI asset type of the rule is evaluating, for joined asset types, it will be the corresponding primary asset types.

string asset_type = 13;

Returns
Type Description
String

The assetType.

getAssetTypeBytes()

public ByteString getAssetTypeBytes()

The CAI asset type of the rule is evaluating, for joined asset types, it will be the corresponding primary asset types.

string asset_type = 13;

Returns
Type Description
ByteString

The bytes for assetType.

getDefaultInstanceForType()

public Rule getDefaultInstanceForType()
Returns
Type Description
Rule

getDescription()

public String getDescription()

Describe rule in plain language.

string description = 4;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Describe rule in plain language.

string description = 4;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

The name display in UI.

string display_name = 3;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The name display in UI.

string display_name = 3;

Returns
Type Description
ByteString

The bytes for displayName.

getErrorMessage()

public String getErrorMessage()

The message template for rule.

string error_message = 8;

Returns
Type Description
String

The errorMessage.

getErrorMessageBytes()

public ByteString getErrorMessageBytes()

The message template for rule.

string error_message = 8;

Returns
Type Description
ByteString

The bytes for errorMessage.

getName()

public String getName()

Rule name.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Rule name.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPrimaryCategory()

public String getPrimaryCategory()

The primary category.

string primary_category = 6;

Returns
Type Description
String

The primaryCategory.

getPrimaryCategoryBytes()

public ByteString getPrimaryCategoryBytes()

The primary category.

string primary_category = 6;

Returns
Type Description
ByteString

The bytes for primaryCategory.

getRemediation()

public String getRemediation()

The remediation for the rule.

string remediation = 10;

Returns
Type Description
String

The remediation.

getRemediationBytes()

public ByteString getRemediationBytes()

The remediation for the rule.

string remediation = 10;

Returns
Type Description
ByteString

The bytes for remediation.

getRevisionId()

public String getRevisionId()

Output only. The version of the rule.

string revision_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The revisionId.

getRevisionIdBytes()

public ByteString getRevisionIdBytes()

Output only. The version of the rule.

string revision_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for revisionId.

getRuleType()

public Rule.RuleType getRuleType()

The type of the rule.

.google.cloud.workloadmanager.v1.Rule.RuleType rule_type = 12;

Returns
Type Description
Rule.RuleType

The ruleType.

getRuleTypeValue()

public int getRuleTypeValue()

The type of the rule.

.google.cloud.workloadmanager.v1.Rule.RuleType rule_type = 12;

Returns
Type Description
int

The enum numeric value on the wire for ruleType.

getSecondaryCategory()

public String getSecondaryCategory()

The secondary category.

string secondary_category = 7;

Returns
Type Description
String

The secondaryCategory.

getSecondaryCategoryBytes()

public ByteString getSecondaryCategoryBytes()

The secondary category.

string secondary_category = 7;

Returns
Type Description
ByteString

The bytes for secondaryCategory.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSeverity()

public String getSeverity()

The severity of the rule.

string severity = 5;

Returns
Type Description
String

The severity.

getSeverityBytes()

public ByteString getSeverityBytes()

The severity of the rule.

string severity = 5;

Returns
Type Description
ByteString

The bytes for severity.

getTags(int index)

public String getTags(int index)

List of user-defined tags.

repeated string tags = 11;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The tags at the given index.

getTagsBytes(int index)

public ByteString getTagsBytes(int index)

List of user-defined tags.

repeated string tags = 11;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the tags at the given index.

getTagsCount()

public int getTagsCount()

List of user-defined tags.

repeated string tags = 11;

Returns
Type Description
int

The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

List of user-defined tags.

repeated string tags = 11;

Returns
Type Description
ProtocolStringList

A list containing the tags.

getUri()

public String getUri()

The document url for the rule.

string uri = 9;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

The document url for the rule.

string uri = 9;

Returns
Type Description
ByteString

The bytes for uri.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Rule.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Rule.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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