public final class Policy extends GeneratedMessageV3 implements PolicyOrBuilder
Defines an organization policy which is used to specify constraints
for configurations of Google Cloud resources.
Protobuf type google.cloud.orgpolicy.v2.Policy
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ALTERNATE_FIELD_NUMBER
public static final int ALTERNATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DRY_RUN_SPEC_FIELD_NUMBER
public static final int DRY_RUN_SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SPEC_FIELD_NUMBER
public static final int SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Policy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Policy.Builder newBuilder()
newBuilder(Policy prototype)
public static Policy.Builder newBuilder(Policy prototype)
| Parameter |
|---|
| Name | Description |
prototype | Policy
|
public static Policy parseDelimitedFrom(InputStream input)
public static Policy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Policy parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Policy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(CodedInputStream input)
public static Policy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(InputStream input)
public static Policy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Policy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Policy> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAlternate() (deprecated)
public AlternatePolicySpec getAlternate()
Deprecated. google.cloud.orgpolicy.v2.Policy.alternate is deprecated. See
google/cloud/orgpolicy/v2/orgpolicy.proto;l=270
Deprecated.
.google.cloud.orgpolicy.v2.AlternatePolicySpec alternate = 3 [deprecated = true];
getAlternateOrBuilder() (deprecated)
public AlternatePolicySpecOrBuilder getAlternateOrBuilder()
Deprecated.
.google.cloud.orgpolicy.v2.AlternatePolicySpec alternate = 3 [deprecated = true];
getDefaultInstanceForType()
public Policy getDefaultInstanceForType()
getDryRunSpec()
public PolicySpec getDryRunSpec()
Dry-run policy.
Audit-only policy, can be used to monitor how the policy would have
impacted the existing and future resources if it's enforced.
.google.cloud.orgpolicy.v2.PolicySpec dry_run_spec = 4;
getDryRunSpecOrBuilder()
public PolicySpecOrBuilder getDryRunSpecOrBuilder()
Dry-run policy.
Audit-only policy, can be used to monitor how the policy would have
impacted the existing and future resources if it's enforced.
.google.cloud.orgpolicy.v2.PolicySpec dry_run_spec = 4;
getEtag()
Optional. An opaque tag indicating the current state of the policy, used
for concurrency control. This 'etag' is computed by the server based on the
value of other fields, and may be sent on update and delete requests to
ensure the client has an up-to-date value before proceeding.
string etag = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
Optional. An opaque tag indicating the current state of the policy, used
for concurrency control. This 'etag' is computed by the server based on the
value of other fields, and may be sent on update and delete requests to
ensure the client has an up-to-date value before proceeding.
string etag = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
getName()
Immutable. The resource name of the policy. Must be one of the following
forms, where constraint_name is the name of the constraint which this
policy configures:
projects/{project_number}/policies/{constraint_name}folders/{folder_id}/policies/{constraint_name}organizations/{organization_id}/policies/{constraint_name}
For example, projects/123/policies/compute.disableSerialPortAccess.
Note: projects/{project_id}/policies/{constraint_name} is also an
acceptable name for API requests, but responses will return the name using
the equivalent project number.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Immutable. The resource name of the policy. Must be one of the following
forms, where constraint_name is the name of the constraint which this
policy configures:
projects/{project_number}/policies/{constraint_name}folders/{folder_id}/policies/{constraint_name}organizations/{organization_id}/policies/{constraint_name}
For example, projects/123/policies/compute.disableSerialPortAccess.
Note: projects/{project_id}/policies/{constraint_name} is also an
acceptable name for API requests, but responses will return the name using
the equivalent project number.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Policy> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSpec()
public PolicySpec getSpec()
Basic information about the Organization Policy.
.google.cloud.orgpolicy.v2.PolicySpec spec = 2;
getSpecOrBuilder()
public PolicySpecOrBuilder getSpecOrBuilder()
Basic information about the Organization Policy.
.google.cloud.orgpolicy.v2.PolicySpec spec = 2;
hasAlternate() (deprecated)
public boolean hasAlternate()
Deprecated. google.cloud.orgpolicy.v2.Policy.alternate is deprecated. See
google/cloud/orgpolicy/v2/orgpolicy.proto;l=270
Deprecated.
.google.cloud.orgpolicy.v2.AlternatePolicySpec alternate = 3 [deprecated = true];
| Returns |
|---|
| Type | Description |
boolean | Whether the alternate field is set.
|
hasDryRunSpec()
public boolean hasDryRunSpec()
Dry-run policy.
Audit-only policy, can be used to monitor how the policy would have
impacted the existing and future resources if it's enforced.
.google.cloud.orgpolicy.v2.PolicySpec dry_run_spec = 4;
| Returns |
|---|
| Type | Description |
boolean | Whether the dryRunSpec field is set.
|
hasSpec()
Basic information about the Organization Policy.
.google.cloud.orgpolicy.v2.PolicySpec spec = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the spec field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Policy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Policy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Policy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
