Class: Google::Cloud::OrgPolicy::V2::Policy

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/orgpolicy/v2/orgpolicy.rb

Overview

Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.

Instance Attribute Summary collapse

Instance Attribute Details

#alternate ⇒ ::Google::Cloud::OrgPolicy::V2::AlternatePolicySpec

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated.

Returns:



59
60
61
62
 
# File 'proto_docs/google/cloud/orgpolicy/v2/orgpolicy.rb', line 59

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dry_run_spec ⇒ ::Google::Cloud::OrgPolicy::V2::PolicySpec

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



59
60
61
62
 
# File 'proto_docs/google/cloud/orgpolicy/v2/orgpolicy.rb', line 59

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#etag ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



59
60
61
62
 
# File 'proto_docs/google/cloud/orgpolicy/v2/orgpolicy.rb', line 59

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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.



59
60
61
62
 
# File 'proto_docs/google/cloud/orgpolicy/v2/orgpolicy.rb', line 59

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#spec ⇒ ::Google::Cloud::OrgPolicy::V2::PolicySpec

Returns Basic information about the Organization Policy.

Returns:



59
60
61
62
 
# File 'proto_docs/google/cloud/orgpolicy/v2/orgpolicy.rb', line 59

class Policy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end