Class AnalyzerOrgPolicyConstraint.CustomConstraint (3.31.0)

public static final class AnalyzerOrgPolicyConstraint.CustomConstraint extends GeneratedMessageV3 implements AnalyzerOrgPolicyConstraint.CustomConstraintOrBuilder

The definition of a custom constraint.

Protobuf type google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AnalyzerOrgPolicyConstraint.CustomConstraint

Static Fields

ACTION_TYPE_FIELD_NUMBER

public static final int ACTION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CONDITION_FIELD_NUMBER

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

METHOD_TYPES_FIELD_NUMBER

public static final int METHOD_TYPES_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_TYPES_FIELD_NUMBER

public static final int RESOURCE_TYPES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnalyzerOrgPolicyConstraint.CustomConstraint getDefaultInstance()
Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint

getDescriptor()

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

newBuilder()

public static AnalyzerOrgPolicyConstraint.CustomConstraint.Builder newBuilder()
Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint.Builder

newBuilder(AnalyzerOrgPolicyConstraint.CustomConstraint prototype)

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

parseDelimitedFrom(InputStream input)

public static AnalyzerOrgPolicyConstraint.CustomConstraint parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static AnalyzerOrgPolicyConstraint.CustomConstraint parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static AnalyzerOrgPolicyConstraint.CustomConstraint parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static AnalyzerOrgPolicyConstraint.CustomConstraint parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static AnalyzerOrgPolicyConstraint.CustomConstraint parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<AnalyzerOrgPolicyConstraint.CustomConstraint> parser()
Returns
Type Description
Parser<CustomConstraint>

Methods

equals(Object obj)

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

getActionType()

public AnalyzerOrgPolicyConstraint.CustomConstraint.ActionType getActionType()

Allow or deny type.

.google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint.ActionType action_type = 5;

Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint.ActionType

The actionType.

getActionTypeValue()

public int getActionTypeValue()

Allow or deny type.

.google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint.ActionType action_type = 5;

Returns
Type Description
int

The enum numeric value on the wire for actionType.

getCondition()

public String getCondition()

Organization Policy condition/expression. For example: resource.instanceName.matches("[production|test].*(\d)+")' or, resource.management.auto_upgrade == true

string condition = 4;

Returns
Type Description
String

The condition.

getConditionBytes()

public ByteString getConditionBytes()

Organization Policy condition/expression. For example: resource.instanceName.matches("[production|test].*(\d)+")' or, resource.management.auto_upgrade == true

string condition = 4;

Returns
Type Description
ByteString

The bytes for condition.

getDefaultInstanceForType()

public AnalyzerOrgPolicyConstraint.CustomConstraint getDefaultInstanceForType()
Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint

getDescription()

public String getDescription()

Detailed information about this custom policy constraint.

string description = 7;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Detailed information about this custom policy constraint.

string description = 7;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

One line display name for the UI.

string display_name = 6;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

One line display name for the UI.

string display_name = 6;

Returns
Type Description
ByteString

The bytes for displayName.

getMethodTypes(int index)

public AnalyzerOrgPolicyConstraint.CustomConstraint.MethodType getMethodTypes(int index)

All the operations being applied for this constraint.

repeated .google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint.MethodType method_types = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint.MethodType

The methodTypes at the given index.

getMethodTypesCount()

public int getMethodTypesCount()

All the operations being applied for this constraint.

repeated .google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint.MethodType method_types = 3;

Returns
Type Description
int

The count of methodTypes.

getMethodTypesList()

public List<AnalyzerOrgPolicyConstraint.CustomConstraint.MethodType> getMethodTypesList()

All the operations being applied for this constraint.

repeated .google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint.MethodType method_types = 3;

Returns
Type Description
List<MethodType>

A list containing the methodTypes.

getMethodTypesValue(int index)

public int getMethodTypesValue(int index)

All the operations being applied for this constraint.

repeated .google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint.MethodType method_types = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

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

getMethodTypesValueList()

public List<Integer> getMethodTypesValueList()

All the operations being applied for this constraint.

repeated .google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint.MethodType method_types = 3;

Returns
Type Description
List<Integer>

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

getName()

public String getName()

Name of the constraint. This is unique within the organization. Format of the name should be

  • organizations/{organization_id}/customConstraints/{custom_constraint_id}

    Example : "organizations/123/customConstraints/custom.createOnlyE2TypeVms"

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the constraint. This is unique within the organization. Format of the name should be

  • organizations/{organization_id}/customConstraints/{custom_constraint_id}

    Example : "organizations/123/customConstraints/custom.createOnlyE2TypeVms"

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<AnalyzerOrgPolicyConstraint.CustomConstraint> getParserForType()
Returns
Type Description
Parser<CustomConstraint>
Overrides

getResourceTypes(int index)

public String getResourceTypes(int index)

The Resource Instance type on which this policy applies to. Format will be of the form : "<canonical service name>/<type>" Example:

  • compute.googleapis.com/Instance.

repeated string resource_types = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The resourceTypes at the given index.

getResourceTypesBytes(int index)

public ByteString getResourceTypesBytes(int index)

The Resource Instance type on which this policy applies to. Format will be of the form : "<canonical service name>/<type>" Example:

  • compute.googleapis.com/Instance.

repeated string resource_types = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the resourceTypes at the given index.

getResourceTypesCount()

public int getResourceTypesCount()

The Resource Instance type on which this policy applies to. Format will be of the form : "<canonical service name>/<type>" Example:

  • compute.googleapis.com/Instance.

repeated string resource_types = 2;

Returns
Type Description
int

The count of resourceTypes.

getResourceTypesList()

public ProtocolStringList getResourceTypesList()

The Resource Instance type on which this policy applies to. Format will be of the form : "<canonical service name>/<type>" Example:

  • compute.googleapis.com/Instance.

repeated string resource_types = 2;

Returns
Type Description
ProtocolStringList

A list containing the resourceTypes.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 AnalyzerOrgPolicyConstraint.CustomConstraint.Builder newBuilderForType()
Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public AnalyzerOrgPolicyConstraint.CustomConstraint.Builder toBuilder()
Returns
Type Description
AnalyzerOrgPolicyConstraint.CustomConstraint.Builder

writeTo(CodedOutputStream output)

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