Class Rule (1.53.0)

public final class Rule extends GeneratedMessageV3 implements RuleOrBuilder

A rule defines the deny or allow action of the operation it applies to and the conditions required for the rule to apply. You can set one rule for an entire repository and one rule for each package within.

Protobuf type google.devtools.artifactregistry.v1.Rule

Implements

RuleOrBuilder

Static Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER
Field Value
Type Description
int

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_FIELD_NUMBER

public static final int OPERATION_FIELD_NUMBER
Field Value
Type Description
int

PACKAGE_ID_FIELD_NUMBER

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

getAction()

public Rule.Action getAction()

The action this rule takes.

.google.devtools.artifactregistry.v1.Rule.Action action = 2;

Returns
Type Description
Rule.Action

The action.

getActionValue()

public int getActionValue()

The action this rule takes.

.google.devtools.artifactregistry.v1.Rule.Action action = 2;

Returns
Type Description
int

The enum numeric value on the wire for action.

getCondition()

public Expr getCondition()

Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects.

.google.type.Expr condition = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Expr

The condition.

getConditionOrBuilder()

public ExprOrBuilder getConditionOrBuilder()

Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects.

.google.type.Expr condition = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.ExprOrBuilder

getDefaultInstanceForType()

public Rule getDefaultInstanceForType()
Returns
Type Description
Rule

getName()

public String getName()

The name of the rule, for example: projects/p1/locations/us-central1/repositories/repo1/rules/rule1.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the rule, for example: projects/p1/locations/us-central1/repositories/repo1/rules/rule1.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOperation()

public Rule.Operation getOperation()

.google.devtools.artifactregistry.v1.Rule.Operation operation = 3;

Returns
Type Description
Rule.Operation

The operation.

getOperationValue()

public int getOperationValue()

.google.devtools.artifactregistry.v1.Rule.Operation operation = 3;

Returns
Type Description
int

The enum numeric value on the wire for operation.

getPackageId()

public String getPackageId()

The package ID the rule applies to. If empty, this rule applies to all packages inside the repository.

string package_id = 5;

Returns
Type Description
String

The packageId.

getPackageIdBytes()

public ByteString getPackageIdBytes()

The package ID the rule applies to. If empty, this rule applies to all packages inside the repository.

string package_id = 5;

Returns
Type Description
ByteString

The bytes for packageId.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCondition()

public boolean hasCondition()

Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects.

.google.type.Expr condition = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the condition field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
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