Constraint.Builder (Google Cloud Org Policy Parent 2.0.3 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
    - - com.google.cloud.orgpolicy.v2.Constraint.Builder

All Implemented Interfaces:: ConstraintOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:: Constraint

public static final class Constraint.Builder
extends GeneratedMessageV3.Builder<Constraint.Builder>
implements ConstraintOrBuilder

 A `constraint` describes a way to restrict resource's configuration. For
 example, you could enforce a constraint that controls which cloud services
 can be activated across an organization, or whether a Compute Engine instance
 can have serial port connections established. `Constraints` can be configured
 by the organization's policy adminstrator to fit the needs of the organzation
 by setting a `policy` that includes `constraints` at different locations in
 the organization's resource hierarchy. Policies are inherited down the
 resource hierarchy from higher levels, but can also be overridden. For
 details about the inheritance rules please read about
 [`policies`][google.cloud.OrgPolicy.v2.Policy].
 `Constraints` have a default behavior determined by the `constraint_default`
 field, which is the enforcement behavior that is used in the absence of a
 `policy` being defined or inherited for the resource in question.

Protobuf type google.cloud.orgpolicy.v2.Constraint

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Constraint.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)`
`Constraint`	`build()`
`Constraint`	`buildPartial()`
`Constraint.Builder`	`clear()`
`Constraint.Builder`	`clearBooleanConstraint()` Defines this constraint as being a BooleanConstraint.
`Constraint.Builder`	`clearConstraintDefault()` The evaluation behavior of this constraint in the absence of 'Policy'.
`Constraint.Builder`	`clearConstraintType()`
`Constraint.Builder`	`clearDescription()` Detailed description of what this `Constraint` controls as well as how and where it is enforced.
`Constraint.Builder`	`clearDisplayName()` The human readable name.
`Constraint.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`Constraint.Builder`	`clearListConstraint()` Defines this constraint as being a ListConstraint.
`Constraint.Builder`	`clearName()` Immutable.
`Constraint.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`Constraint.Builder`	`clone()`
`Constraint.BooleanConstraint`	`getBooleanConstraint()` Defines this constraint as being a BooleanConstraint.
`Constraint.BooleanConstraint.Builder`	`getBooleanConstraintBuilder()` Defines this constraint as being a BooleanConstraint.
`Constraint.BooleanConstraintOrBuilder`	`getBooleanConstraintOrBuilder()` Defines this constraint as being a BooleanConstraint.
`Constraint.ConstraintDefault`	`getConstraintDefault()` The evaluation behavior of this constraint in the absence of 'Policy'.
`int`	`getConstraintDefaultValue()` The evaluation behavior of this constraint in the absence of 'Policy'.
`Constraint.ConstraintTypeCase`	`getConstraintTypeCase()`
`Constraint`	`getDefaultInstanceForType()`
`String`	`getDescription()` Detailed description of what this `Constraint` controls as well as how and where it is enforced.
`ByteString`	`getDescriptionBytes()` Detailed description of what this `Constraint` controls as well as how and where it is enforced.
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getDisplayName()` The human readable name.
`ByteString`	`getDisplayNameBytes()` The human readable name.
`Constraint.ListConstraint`	`getListConstraint()` Defines this constraint as being a ListConstraint.
`Constraint.ListConstraint.Builder`	`getListConstraintBuilder()` Defines this constraint as being a ListConstraint.
`Constraint.ListConstraintOrBuilder`	`getListConstraintOrBuilder()` Defines this constraint as being a ListConstraint.
`String`	`getName()` Immutable.
`ByteString`	`getNameBytes()` Immutable.
`boolean`	`hasBooleanConstraint()` Defines this constraint as being a BooleanConstraint.
`boolean`	`hasListConstraint()` Defines this constraint as being a ListConstraint.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Constraint.Builder`	`mergeBooleanConstraint(Constraint.BooleanConstraint value)` Defines this constraint as being a BooleanConstraint.
`Constraint.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`Constraint.Builder`	`mergeFrom(Constraint other)`
`Constraint.Builder`	`mergeFrom(Message other)`
`Constraint.Builder`	`mergeListConstraint(Constraint.ListConstraint value)` Defines this constraint as being a ListConstraint.
`Constraint.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`Constraint.Builder`	`setBooleanConstraint(Constraint.BooleanConstraint.Builder builderForValue)` Defines this constraint as being a BooleanConstraint.
`Constraint.Builder`	`setBooleanConstraint(Constraint.BooleanConstraint value)` Defines this constraint as being a BooleanConstraint.
`Constraint.Builder`	`setConstraintDefault(Constraint.ConstraintDefault value)` The evaluation behavior of this constraint in the absence of 'Policy'.
`Constraint.Builder`	`setConstraintDefaultValue(int value)` The evaluation behavior of this constraint in the absence of 'Policy'.
`Constraint.Builder`	`setDescription(String value)` Detailed description of what this `Constraint` controls as well as how and where it is enforced.
`Constraint.Builder`	`setDescriptionBytes(ByteString value)` Detailed description of what this `Constraint` controls as well as how and where it is enforced.
`Constraint.Builder`	`setDisplayName(String value)` The human readable name.
`Constraint.Builder`	`setDisplayNameBytes(ByteString value)` The human readable name.
`Constraint.Builder`	`setField(Descriptors.FieldDescriptor field, Object value)`
`Constraint.Builder`	`setListConstraint(Constraint.ListConstraint.Builder builderForValue)` Defines this constraint as being a ListConstraint.
`Constraint.Builder`	`setListConstraint(Constraint.ListConstraint value)` Defines this constraint as being a ListConstraint.
`Constraint.Builder`	`setName(String value)` Immutable.
`Constraint.Builder`	`setNameBytes(ByteString value)` Immutable.
`Constraint.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)`
`Constraint.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Constraint.Builder>

clear
```
public Constraint.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<Constraint.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<Constraint.Builder>

getDefaultInstanceForType
```
public Constraint getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public Constraint build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public Constraint buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public Constraint.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<Constraint.Builder>

setField

public Constraint.Builder setField(Descriptors.FieldDescriptor field,
                                   Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<Constraint.Builder>

clearField
```
public Constraint.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<Constraint.Builder>

clearOneof
```
public Constraint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<Constraint.Builder>

setRepeatedField

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

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<Constraint.Builder>

addRepeatedField

public Constraint.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                           Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<Constraint.Builder>

mergeFrom
```
public Constraint.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Constraint.Builder>

mergeFrom

public Constraint.Builder mergeFrom(Constraint other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<Constraint.Builder>

mergeFrom

public Constraint.Builder mergeFrom(CodedInputStream input,
                                    ExtensionRegistryLite extensionRegistry)
                             throws IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<Constraint.Builder>
Throws:: IOException

getConstraintTypeCase
```
public Constraint.ConstraintTypeCase getConstraintTypeCase()
```
Specified by:

getConstraintTypeCase in interface ConstraintOrBuilder

clearConstraintType

public Constraint.Builder clearConstraintType()

getName

public String getName()

 Immutable. The resource name of the Constraint. Must be in one of
 the following forms:
 * `projects/{project_number}/constraints/{constraint_name}`
 * `folders/{folder_id}/constraints/{constraint_name}`
 * `organizations/{organization_id}/constraints/{constraint_name}`
 For example, "/projects/123/constraints/compute.disableSerialPortAccess".

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Specified by:: getName in interface ConstraintOrBuilder
Returns:: The name.

getNameBytes

public ByteString getNameBytes()

 Immutable. The resource name of the Constraint. Must be in one of
 the following forms:
 * `projects/{project_number}/constraints/{constraint_name}`
 * `folders/{folder_id}/constraints/{constraint_name}`
 * `organizations/{organization_id}/constraints/{constraint_name}`
 For example, "/projects/123/constraints/compute.disableSerialPortAccess".

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Specified by:: getNameBytes in interface ConstraintOrBuilder
Returns:: The bytes for name.

setName

public Constraint.Builder setName(String value)

 Immutable. The resource name of the Constraint. Must be in one of
 the following forms:
 * `projects/{project_number}/constraints/{constraint_name}`
 * `folders/{folder_id}/constraints/{constraint_name}`
 * `organizations/{organization_id}/constraints/{constraint_name}`
 For example, "/projects/123/constraints/compute.disableSerialPortAccess".

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameters:: value - The name to set.
Returns:: This builder for chaining.

clearName

public Constraint.Builder clearName()

 Immutable. The resource name of the Constraint. Must be in one of
 the following forms:
 * `projects/{project_number}/constraints/{constraint_name}`
 * `folders/{folder_id}/constraints/{constraint_name}`
 * `organizations/{organization_id}/constraints/{constraint_name}`
 For example, "/projects/123/constraints/compute.disableSerialPortAccess".

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns:: This builder for chaining.

setNameBytes

public Constraint.Builder setNameBytes(ByteString value)

 Immutable. The resource name of the Constraint. Must be in one of
 the following forms:
 * `projects/{project_number}/constraints/{constraint_name}`
 * `folders/{folder_id}/constraints/{constraint_name}`
 * `organizations/{organization_id}/constraints/{constraint_name}`
 For example, "/projects/123/constraints/compute.disableSerialPortAccess".

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameters:: value - The bytes for name to set.
Returns:: This builder for chaining.

getDisplayName
```
public String getDisplayName()
```
```
 The human readable name.
 Mutable.
 
```
string display_name = 2;
Specified by:

getDisplayName in interface ConstraintOrBuilder

Returns:

The displayName.

getDisplayNameBytes
```
public ByteString getDisplayNameBytes()
```
```
 The human readable name.
 Mutable.
 
```
string display_name = 2;
Specified by:

getDisplayNameBytes in interface ConstraintOrBuilder

Returns:

The bytes for displayName.

setDisplayName
```
public Constraint.Builder setDisplayName(String value)
```
```
 The human readable name.
 Mutable.
 
```
string display_name = 2;
Parameters:

value - The displayName to set.

Returns:

This builder for chaining.

clearDisplayName

public Constraint.Builder clearDisplayName()

 The human readable name.
 Mutable.

string display_name = 2;

Returns:: This builder for chaining.

setDisplayNameBytes
```
public Constraint.Builder setDisplayNameBytes(ByteString value)
```
```
 The human readable name.
 Mutable.
 
```
string display_name = 2;
Parameters:

value - The bytes for displayName to set.

Returns:

This builder for chaining.

getDescription

public String getDescription()

 Detailed description of what this `Constraint` controls as well as how and
 where it is enforced.
 Mutable.

string description = 3;

Specified by:: getDescription in interface ConstraintOrBuilder
Returns:: The description.

getDescriptionBytes

public ByteString getDescriptionBytes()

 Detailed description of what this `Constraint` controls as well as how and
 where it is enforced.
 Mutable.

string description = 3;

Specified by:: getDescriptionBytes in interface ConstraintOrBuilder
Returns:: The bytes for description.

setDescription

public Constraint.Builder setDescription(String value)

 Detailed description of what this `Constraint` controls as well as how and
 where it is enforced.
 Mutable.

string description = 3;

Parameters:: value - The description to set.
Returns:: This builder for chaining.

clearDescription

public Constraint.Builder clearDescription()

 Detailed description of what this `Constraint` controls as well as how and
 where it is enforced.
 Mutable.

string description = 3;

Returns:: This builder for chaining.

setDescriptionBytes

public Constraint.Builder setDescriptionBytes(ByteString value)

 Detailed description of what this `Constraint` controls as well as how and
 where it is enforced.
 Mutable.

string description = 3;

Parameters:: value - The bytes for description to set.
Returns:: This builder for chaining.

getConstraintDefaultValue
```
public int getConstraintDefaultValue()
```
```
 The evaluation behavior of this constraint in the absence of 'Policy'.
 
```
.google.cloud.orgpolicy.v2.Constraint.ConstraintDefault constraint_default = 4;
Specified by:

getConstraintDefaultValue in interface ConstraintOrBuilder

Returns:

The enum numeric value on the wire for constraintDefault.

setConstraintDefaultValue
```
public Constraint.Builder setConstraintDefaultValue(int value)
```
```
 The evaluation behavior of this constraint in the absence of 'Policy'.
 
```
.google.cloud.orgpolicy.v2.Constraint.ConstraintDefault constraint_default = 4;
Parameters:

value - The enum numeric value on the wire for constraintDefault to set.

Returns:

This builder for chaining.

getConstraintDefault
```
public Constraint.ConstraintDefault getConstraintDefault()
```
```
 The evaluation behavior of this constraint in the absence of 'Policy'.
 
```
.google.cloud.orgpolicy.v2.Constraint.ConstraintDefault constraint_default = 4;
Specified by:

getConstraintDefault in interface ConstraintOrBuilder

Returns:

The constraintDefault.

setConstraintDefault
```
public Constraint.Builder setConstraintDefault(Constraint.ConstraintDefault value)
```
```
 The evaluation behavior of this constraint in the absence of 'Policy'.
 
```
.google.cloud.orgpolicy.v2.Constraint.ConstraintDefault constraint_default = 4;
Parameters:

value - The constraintDefault to set.

Returns:

This builder for chaining.

clearConstraintDefault
```
public Constraint.Builder clearConstraintDefault()
```
```
 The evaluation behavior of this constraint in the absence of 'Policy'.
 
```
.google.cloud.orgpolicy.v2.Constraint.ConstraintDefault constraint_default = 4;
Returns:

This builder for chaining.

hasListConstraint
```
public boolean hasListConstraint()
```
```
 Defines this constraint as being a ListConstraint.
 
```
.google.cloud.orgpolicy.v2.Constraint.ListConstraint list_constraint = 5;
Specified by:

hasListConstraint in interface ConstraintOrBuilder

Returns:

Whether the listConstraint field is set.

getListConstraint
```
public Constraint.ListConstraint getListConstraint()
```
```
 Defines this constraint as being a ListConstraint.
 
```
.google.cloud.orgpolicy.v2.Constraint.ListConstraint list_constraint = 5;
Specified by:

getListConstraint in interface ConstraintOrBuilder

Returns:

The listConstraint.