com.google.cloud.orgpolicy.v2

Interface PolicyOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Policy, Policy.Builder

public interface PolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AlternatePolicySpec	getAlternate() Deprecated. google.cloud.orgpolicy.v2.Policy.alternate is deprecated. See google/cloud/orgpolicy/v2/orgpolicy.proto;l=270
AlternatePolicySpecOrBuilder	getAlternateOrBuilder() Deprecated.
PolicySpec	getDryRunSpec() Dry-run policy.
PolicySpecOrBuilder	getDryRunSpecOrBuilder() Dry-run policy.
String	getEtag() Optional.
com.google.protobuf.ByteString	getEtagBytes() Optional.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
PolicySpec	getSpec() Basic information about the Organization Policy.
PolicySpecOrBuilder	getSpecOrBuilder() Basic information about the Organization Policy.
boolean	hasAlternate() Deprecated. google.cloud.orgpolicy.v2.Policy.alternate is deprecated. See google/cloud/orgpolicy/v2/orgpolicy.proto;l=270
boolean	hasDryRunSpec() Dry-run policy.
boolean	hasSpec() Basic information about the Organization Policy.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String 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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

hasSpec

boolean hasSpec()

 Basic information about the Organization Policy.
 

.google.cloud.orgpolicy.v2.PolicySpec spec = 2;

Returns:

Whether the spec field is set.

getSpec

PolicySpec getSpec()

 Basic information about the Organization Policy.
 

.google.cloud.orgpolicy.v2.PolicySpec spec = 2;

Returns:

The spec.

getSpecOrBuilder

PolicySpecOrBuilder getSpecOrBuilder()

 Basic information about the Organization Policy.
 

.google.cloud.orgpolicy.v2.PolicySpec spec = 2;

hasAlternate

@Deprecated
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:

Whether the alternate field is set.

getAlternate

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

Returns:

The alternate.

getAlternateOrBuilder

@Deprecated
AlternatePolicySpecOrBuilder getAlternateOrBuilder()

Deprecated.

 Deprecated.
 

.google.cloud.orgpolicy.v2.AlternatePolicySpec alternate = 3 [deprecated = true];

hasDryRunSpec

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:

Whether the dryRunSpec field is set.

getDryRunSpec

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;

Returns:

The dryRunSpec.

getDryRunSpecOrBuilder

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

String 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:

The etag.

getEtagBytes

com.google.protobuf.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:

The bytes for etag.