Interface PolicyOrBuilder (2.45.0) 

public interface PolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAlternate() (deprecated)

public abstract 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
Type Description
AlternatePolicySpec

The alternate.

getAlternateOrBuilder() (deprecated)

public abstract AlternatePolicySpecOrBuilder getAlternateOrBuilder()

Deprecated.

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

Returns
Type Description
AlternatePolicySpecOrBuilder

getDryRunSpec()

public abstract 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
Type Description
PolicySpec

The dryRunSpec.

getDryRunSpecOrBuilder()

public abstract 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;

Returns
Type Description
PolicySpecOrBuilder

getEtag()

public abstract 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
Type Description
String

The etag.

getEtagBytes()

public abstract 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()

public abstract 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
Type Description
String

The name.

getNameBytes()

public abstract 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.

getSpec()

public abstract PolicySpec getSpec()

Basic information about the Organization Policy.

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

Returns
Type Description
PolicySpec

The spec.

getSpecOrBuilder()

public abstract PolicySpecOrBuilder getSpecOrBuilder()

Basic information about the Organization Policy.

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

Returns
Type Description
PolicySpecOrBuilder

hasAlternate() (deprecated)

public abstract 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 abstract 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()

public abstract boolean hasSpec()

Basic information about the Organization Policy.

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

Returns
Type Description
boolean

Whether the spec field is set.