Class Policy.BooleanPolicy (2.42.0)

public static final class Policy.BooleanPolicy extends GeneratedMessageV3 implements Policy.BooleanPolicyOrBuilder

Used in policy_type to specify how boolean_policy will behave at this resource.

Protobuf type google.cloud.orgpolicy.v1.Policy.BooleanPolicy

Static Fields

ENFORCED_FIELD_NUMBER

public static final int ENFORCED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Policy.BooleanPolicy getDefaultInstance()
Returns
Type Description
Policy.BooleanPolicy

getDescriptor()

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

newBuilder()

public static Policy.BooleanPolicy.Builder newBuilder()
Returns
Type Description
Policy.BooleanPolicy.Builder

newBuilder(Policy.BooleanPolicy prototype)

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

parseDelimitedFrom(InputStream input)

public static Policy.BooleanPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Policy.BooleanPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Policy.BooleanPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Policy.BooleanPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Policy.BooleanPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Policy.BooleanPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Policy.BooleanPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Policy.BooleanPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Policy.BooleanPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Policy.BooleanPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Policy.BooleanPolicy> parser()
Returns
Type Description
Parser<BooleanPolicy>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Policy.BooleanPolicy getDefaultInstanceForType()
Returns
Type Description
Policy.BooleanPolicy

getEnforced()

public boolean getEnforced()

If true, then the Policy is enforced. If false, then any configuration is acceptable.

Suppose you have a Constraint constraints/compute.disableSerialPortAccess with constraint_default set to ALLOW. A Policy for that Constraint exhibits the following behavior:

  • If the Policy at this resource has enforced set to false, serial port connection attempts will be allowed.
  • If the Policy at this resource has enforced set to true, serial port connection attempts will be refused.
  • If the Policy at this resource is RestoreDefault, serial port connection attempts will be allowed.
  • If no Policy is set at this resource or anywhere higher in the resource hierarchy, serial port connection attempts will be allowed.
  • If no Policy is set at this resource, but one exists higher in the resource hierarchy, the behavior is as if thePolicy were set at this resource.

    The following examples demonstrate the different possible layerings:

    Example 1 (nearest Constraint wins): organizations/foo has a Policy with: {enforced: false} projects/bar has no Policy set. The constraint at projects/bar and organizations/foo will not be enforced.

    Example 2 (enforcement gets replaced): organizations/foo has a Policy with: {enforced: false} projects/bar has a Policy with: {enforced: true} The constraint at organizations/foo is not enforced. The constraint at projects/bar is enforced.

    Example 3 (RestoreDefault): organizations/foo has a Policy with: {enforced: true} projects/bar has a Policy with: {RestoreDefault: {}} The constraint at organizations/foo is enforced. The constraint at projects/bar is not enforced, because constraint_default for the Constraint is ALLOW.

bool enforced = 1;

Returns
Type Description
boolean

The enforced.

getParserForType()

public Parser<Policy.BooleanPolicy> getParserForType()
Returns
Type Description
Parser<BooleanPolicy>
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Policy.BooleanPolicy.Builder toBuilder()
Returns
Type Description
Policy.BooleanPolicy.Builder

writeTo(CodedOutputStream output)

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