com.google.cloud.orgpolicy.v1

Class Policy

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.orgpolicy.v1.Policy

All Implemented Interfaces:

PolicyOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class Policy
extends GeneratedMessageV3
implements PolicyOrBuilder

 Defines a Cloud Organization `Policy` which is used to specify `Constraints`
 for configurations of Cloud Platform resources.
 

Protobuf type google.cloud.orgpolicy.v1.Policy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Policy.BooleanPolicy Used in `policy_type` to specify how `boolean_policy` will behave at this resource.
static interface	Policy.BooleanPolicyOrBuilder
static class	Policy.Builder Defines a Cloud Organization `Policy` which is used to specify `Constraints` for configurations of Cloud Platform resources.
static class	Policy.ListPolicy Used in `policy_type` to specify how `list_policy` behaves at this resource.
static interface	Policy.ListPolicyOrBuilder
static class	Policy.PolicyTypeCase
static class	Policy.RestoreDefault Ignores policies set above this resource and restores the `constraint_default` enforcement behavior of the specific `Constraint` at this resource.
static interface	Policy.RestoreDefaultOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOOLEAN_POLICY_FIELD_NUMBER
static int	CONSTRAINT_FIELD_NUMBER
static int	ETAG_FIELD_NUMBER
static int	LIST_POLICY_FIELD_NUMBER
static int	RESTORE_DEFAULT_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER
static int	VERSION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Policy.BooleanPolicy	getBooleanPolicy() For boolean `Constraints`, whether to enforce the `Constraint` or not.
Policy.BooleanPolicyOrBuilder	getBooleanPolicyOrBuilder() For boolean `Constraints`, whether to enforce the `Constraint` or not.
String	getConstraint() The name of the `Constraint` the `Policy` is configuring, for example, `constraints/serviceuser.services`.
ByteString	getConstraintBytes() The name of the `Constraint` the `Policy` is configuring, for example, `constraints/serviceuser.services`.
static Policy	getDefaultInstance()
Policy	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
ByteString	getEtag() An opaque tag indicating the current version of the `Policy`, used for concurrency control.
Policy.ListPolicy	getListPolicy() List of values either allowed or disallowed.
Policy.ListPolicyOrBuilder	getListPolicyOrBuilder() List of values either allowed or disallowed.
Parser<Policy>	getParserForType()
Policy.PolicyTypeCase	getPolicyTypeCase()
Policy.RestoreDefault	getRestoreDefault() Restores the default behavior of the constraint; independent of `Constraint` type.
Policy.RestoreDefaultOrBuilder	getRestoreDefaultOrBuilder() Restores the default behavior of the constraint; independent of `Constraint` type.
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
Timestamp	getUpdateTime() The time stamp the `Policy` was previously updated.
TimestampOrBuilder	getUpdateTimeOrBuilder() The time stamp the `Policy` was previously updated.
int	getVersion() Version of the `Policy`.
boolean	hasBooleanPolicy() For boolean `Constraints`, whether to enforce the `Constraint` or not.
int	hashCode()
boolean	hasListPolicy() List of values either allowed or disallowed.
boolean	hasRestoreDefault() Restores the default behavior of the constraint; independent of `Constraint` type.
boolean	hasUpdateTime() The time stamp the `Policy` was previously updated.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Policy.Builder	newBuilder()
static Policy.Builder	newBuilder(Policy prototype)
Policy.Builder	newBuilderForType()
protected Policy.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static Policy	parseDelimitedFrom(InputStream input)
static Policy	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Policy	parseFrom(byte[] data)
static Policy	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Policy	parseFrom(ByteBuffer data)
static Policy	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Policy	parseFrom(ByteString data)
static Policy	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Policy	parseFrom(CodedInputStream input)
static Policy	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Policy	parseFrom(InputStream input)
static Policy	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Policy>	parser()
Policy.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER

See Also:

Constant Field Values

CONSTRAINT_FIELD_NUMBER

public static final int CONSTRAINT_FIELD_NUMBER

See Also:

Constant Field Values

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

LIST_POLICY_FIELD_NUMBER

public static final int LIST_POLICY_FIELD_NUMBER

See Also:

Constant Field Values

BOOLEAN_POLICY_FIELD_NUMBER

public static final int BOOLEAN_POLICY_FIELD_NUMBER

See Also:

Constant Field Values

RESTORE_DEFAULT_FIELD_NUMBER

public static final int RESTORE_DEFAULT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getPolicyTypeCase

public Policy.PolicyTypeCase getPolicyTypeCase()

Specified by:

getPolicyTypeCase in interface PolicyOrBuilder

getVersion

public int getVersion()

 Version of the `Policy`. Default version is 0;
 

int32 version = 1;

Specified by:

getVersion in interface PolicyOrBuilder

Returns:

The version.

getConstraint

public String getConstraint()

 The name of the `Constraint` the `Policy` is configuring, for example,
 `constraints/serviceuser.services`.
 Immutable after creation.
 

string constraint = 2;

Specified by:

getConstraint in interface PolicyOrBuilder

Returns:

The constraint.

getConstraintBytes

public ByteString getConstraintBytes()

 The name of the `Constraint` the `Policy` is configuring, for example,
 `constraints/serviceuser.services`.
 Immutable after creation.
 

string constraint = 2;

Specified by:

getConstraintBytes in interface PolicyOrBuilder

Returns:

The bytes for constraint.

getEtag

public ByteString getEtag()

 An opaque tag indicating the current version of the `Policy`, used for
 concurrency control.
 When the `Policy` is returned from either a `GetPolicy` or a
 `ListOrgPolicy` request, this `etag` indicates the version of the current
 `Policy` to use when executing a read-modify-write loop.
 When the `Policy` is returned from a `GetEffectivePolicy` request, the
 `etag` will be unset.
 When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
 that was returned from a `GetOrgPolicy` request as part of a
 read-modify-write loop for concurrency control. Not setting the `etag`in a
 `SetOrgPolicy` request will result in an unconditional write of the
 `Policy`.
 

bytes etag = 3;

Specified by:

getEtag in interface PolicyOrBuilder

Returns:

The etag.

hasUpdateTime

public boolean hasUpdateTime()

 The time stamp the `Policy` was previously updated. This is set by the
 server, not specified by the caller, and represents the last time a call to
 `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
 be ignored.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

hasUpdateTime in interface PolicyOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public Timestamp getUpdateTime()

 The time stamp the `Policy` was previously updated. This is set by the
 server, not specified by the caller, and represents the last time a call to
 `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
 be ignored.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

getUpdateTime in interface PolicyOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public TimestampOrBuilder getUpdateTimeOrBuilder()

 The time stamp the `Policy` was previously updated. This is set by the
 server, not specified by the caller, and represents the last time a call to
 `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
 be ignored.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

getUpdateTimeOrBuilder in interface PolicyOrBuilder

hasListPolicy

public boolean hasListPolicy()

 List of values either allowed or disallowed.
 

.google.cloud.orgpolicy.v1.Policy.ListPolicy list_policy = 5;

Specified by:

hasListPolicy in interface PolicyOrBuilder

Returns:

Whether the listPolicy field is set.

getListPolicy

public Policy.ListPolicy getListPolicy()

 List of values either allowed or disallowed.
 

.google.cloud.orgpolicy.v1.Policy.ListPolicy list_policy = 5;

Specified by:

getListPolicy in interface PolicyOrBuilder

Returns:

The listPolicy.

getListPolicyOrBuilder

public Policy.ListPolicyOrBuilder getListPolicyOrBuilder()

 List of values either allowed or disallowed.
 

.google.cloud.orgpolicy.v1.Policy.ListPolicy list_policy = 5;

Specified by:

getListPolicyOrBuilder in interface PolicyOrBuilder

hasBooleanPolicy

public boolean hasBooleanPolicy()

 For boolean `Constraints`, whether to enforce the `Constraint` or not.
 

.google.cloud.orgpolicy.v1.Policy.BooleanPolicy boolean_policy = 6;

Specified by:

hasBooleanPolicy in interface PolicyOrBuilder

Returns:

Whether the booleanPolicy field is set.

getBooleanPolicy

public Policy.BooleanPolicy getBooleanPolicy()

 For boolean `Constraints`, whether to enforce the `Constraint` or not.
 

.google.cloud.orgpolicy.v1.Policy.BooleanPolicy boolean_policy = 6;

Specified by:

getBooleanPolicy in interface PolicyOrBuilder

Returns:

The booleanPolicy.

getBooleanPolicyOrBuilder

public Policy.BooleanPolicyOrBuilder getBooleanPolicyOrBuilder()

 For boolean `Constraints`, whether to enforce the `Constraint` or not.
 

.google.cloud.orgpolicy.v1.Policy.BooleanPolicy boolean_policy = 6;

Specified by:

getBooleanPolicyOrBuilder in interface PolicyOrBuilder

hasRestoreDefault

public boolean hasRestoreDefault()

 Restores the default behavior of the constraint; independent of
 `Constraint` type.
 

.google.cloud.orgpolicy.v1.Policy.RestoreDefault restore_default = 7;

Specified by:

hasRestoreDefault in interface PolicyOrBuilder

Returns:

Whether the restoreDefault field is set.

getRestoreDefault

public Policy.RestoreDefault getRestoreDefault()

 Restores the default behavior of the constraint; independent of
 `Constraint` type.
 

.google.cloud.orgpolicy.v1.Policy.RestoreDefault restore_default = 7;

Specified by:

getRestoreDefault in interface PolicyOrBuilder

Returns:

The restoreDefault.

getRestoreDefaultOrBuilder

public Policy.RestoreDefaultOrBuilder getRestoreDefaultOrBuilder()

 Restores the default behavior of the constraint; independent of
 `Constraint` type.
 

.google.cloud.orgpolicy.v1.Policy.RestoreDefault restore_default = 7;

Specified by:

getRestoreDefaultOrBuilder in interface PolicyOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Policy parseFrom(ByteBuffer data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Policy parseFrom(ByteBuffer data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Policy parseFrom(ByteString data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Policy parseFrom(ByteString data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Policy parseFrom(byte[] data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Policy parseFrom(byte[] data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Policy parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Policy parseFrom(InputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Policy parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Policy parseDelimitedFrom(InputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Policy parseFrom(CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Policy parseFrom(CodedInputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public Policy.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Policy.Builder newBuilder()

newBuilder

public static Policy.Builder newBuilder(Policy prototype)

toBuilder

public Policy.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Policy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Policy getDefaultInstance()

parser

public static Parser<Policy> parser()

getParserForType

public Parser<Policy> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Policy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder