Class Rule.Builder (1.52.0)

public static final class Rule.Builder extends GeneratedMessageV3.Builder<Rule.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Rule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Rule.Builder
Overrides

build()

public Rule build()
Returns
Type Description
Rule

buildPartial()

public Rule buildPartial()
Returns
Type Description
Rule

clear()

public Rule.Builder clear()
Returns
Type Description
Rule.Builder
Overrides

clearAction()

public Rule.Builder clearAction()

The action this rule takes.

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

Returns
Type Description
Rule.Builder

This builder for chaining.

clearCondition()

public Rule.Builder clearCondition()

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
Rule.Builder

clearField(Descriptors.FieldDescriptor field)

public Rule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Rule.Builder
Overrides

clearName()

public Rule.Builder clearName()

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

string name = 1;

Returns
Type Description
Rule.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Rule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Rule.Builder
Overrides

clearOperation()

public Rule.Builder clearOperation()

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

Returns
Type Description
Rule.Builder

This builder for chaining.

clearPackageId()

public Rule.Builder clearPackageId()

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
Rule.Builder

This builder for chaining.

clone()

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

getConditionBuilder()

public Expr.Builder getConditionBuilder()

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.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCondition(Expr value)

public Rule.Builder mergeCondition(Expr value)

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];

Parameter
Name Description
value com.google.type.Expr
Returns
Type Description
Rule.Builder

mergeFrom(Rule other)

public Rule.Builder mergeFrom(Rule other)
Parameter
Name Description
other Rule
Returns
Type Description
Rule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Rule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Rule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Rule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Rule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Rule.Builder
Overrides

setAction(Rule.Action value)

public Rule.Builder setAction(Rule.Action value)

The action this rule takes.

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

Parameter
Name Description
value Rule.Action

The action to set.

Returns
Type Description
Rule.Builder

This builder for chaining.

setActionValue(int value)

public Rule.Builder setActionValue(int value)

The action this rule takes.

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

Parameter
Name Description
value int

The enum numeric value on the wire for action to set.

Returns
Type Description
Rule.Builder

This builder for chaining.

setCondition(Expr value)

public Rule.Builder setCondition(Expr value)

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];

Parameter
Name Description
value com.google.type.Expr
Returns
Type Description
Rule.Builder

setCondition(Expr.Builder builderForValue)

public Rule.Builder setCondition(Expr.Builder builderForValue)

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];

Parameter
Name Description
builderForValue com.google.type.Expr.Builder
Returns
Type Description
Rule.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Rule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Rule.Builder
Overrides

setName(String value)

public Rule.Builder setName(String value)

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

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Rule.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Rule.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Rule.Builder

This builder for chaining.

setOperation(Rule.Operation value)

public Rule.Builder setOperation(Rule.Operation value)

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

Parameter
Name Description
value Rule.Operation

The operation to set.

Returns
Type Description
Rule.Builder

This builder for chaining.

setOperationValue(int value)

public Rule.Builder setOperationValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for operation to set.

Returns
Type Description
Rule.Builder

This builder for chaining.

setPackageId(String value)

public Rule.Builder setPackageId(String value)

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

string package_id = 5;

Parameter
Name Description
value String

The packageId to set.

Returns
Type Description
Rule.Builder

This builder for chaining.

setPackageIdBytes(ByteString value)

public Rule.Builder setPackageIdBytes(ByteString value)

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

string package_id = 5;

Parameter
Name Description
value ByteString

The bytes for packageId to set.

Returns
Type Description
Rule.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Rule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Rule.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Rule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Rule.Builder
Overrides