Organization Policy V2 API - Class Google::Cloud::OrgPolicy::V2::Policy (v0.5.0)

Version 0.5.0

• 1.2.0 (latest)
• 1.1.0
• 1.0.1
• 0.10.0
• 0.9.2
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.6

Reference documentation and code samples for the Organization Policy V2 API class Google::Cloud::OrgPolicy::V2::Policy.

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

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#alternate

def alternate() -> ::Google::Cloud::OrgPolicy::V2::AlternatePolicySpec

Returns

• (::Google::Cloud::OrgPolicy::V2::AlternatePolicySpec) — Deprecated.

#alternate=

def alternate=(value) -> ::Google::Cloud::OrgPolicy::V2::AlternatePolicySpec

Parameter

• value (::Google::Cloud::OrgPolicy::V2::AlternatePolicySpec) — Deprecated.

Returns

• (::Google::Cloud::OrgPolicy::V2::AlternatePolicySpec) — Deprecated.

#dry_run_spec

def dry_run_spec() -> ::Google::Cloud::OrgPolicy::V2::PolicySpec

Returns

• (::Google::Cloud::OrgPolicy::V2::PolicySpec) — 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.

#dry_run_spec=

def dry_run_spec=(value) -> ::Google::Cloud::OrgPolicy::V2::PolicySpec

Parameter

• value (::Google::Cloud::OrgPolicy::V2::PolicySpec) — 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.

Returns

• (::Google::Cloud::OrgPolicy::V2::PolicySpec) — 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.

#name

def name() -> ::String

Returns

• (::String) — 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.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#spec

def spec() -> ::Google::Cloud::OrgPolicy::V2::PolicySpec

Returns

• (::Google::Cloud::OrgPolicy::V2::PolicySpec) — Basic information about the Organization Policy.

#spec=

def spec=(value) -> ::Google::Cloud::OrgPolicy::V2::PolicySpec

Parameter

• value (::Google::Cloud::OrgPolicy::V2::PolicySpec) — Basic information about the Organization Policy.

Returns

• (::Google::Cloud::OrgPolicy::V2::PolicySpec) — Basic information about the Organization Policy.