Class: Google::Cloud::Deploy::V1::DeployPolicyEvaluationEvent

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

Overview

Payload proto for "clouddeploy.googleapis.com/deploypolicy_evaluation" Platform Log event that describes the deploy policy evaluation event.

Defined Under Namespace

Modules: PolicyVerdict, PolicyVerdictOverride

Instance Attribute Summary collapse

Instance Attribute Details

#allowed ⇒ ::Boolean

Returns Whether the request is allowed. Allowed is set as true if: (1) the request complies with the policy; or (2) the request doesn't comply with the policy but the policy was overridden; or (3) the request doesn't comply with the policy but the policy was suspended.

Returns:

  • (::Boolean) —

    Whether the request is allowed. Allowed is set as true if: (1) the request complies with the policy; or (2) the request doesn't comply with the policy but the policy was overridden; or (3) the request doesn't comply with the policy but the policy was suspended



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#delivery_pipeline ⇒ ::String

Returns The name of the Delivery Pipeline.

Returns:

  • (::String) —

    The name of the Delivery Pipeline.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#deploy_policy ⇒ ::String

Returns The name of the DeployPolicy.

Returns:

  • (::String) —

    The name of the DeployPolicy.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#deploy_policy_uid ⇒ ::String

Returns Unique identifier of the DeployPolicy.

Returns:

  • (::String) —

    Unique identifier of the DeployPolicy.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#invoker ⇒ ::Google::Cloud::Deploy::V1::DeployPolicy::Invoker

Returns What invoked the action (e.g. a user or automation).

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#message ⇒ ::String

Returns Debug message for when a deploy policy event occurs.

Returns:

  • (::String) —

    Debug message for when a deploy policy event occurs.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#overrides ⇒ ::Array<::Google::Cloud::Deploy::V1::DeployPolicyEvaluationEvent::PolicyVerdictOverride>

Returns Things that could have overridden the policy verdict. Overrides together with verdict decide whether the request is allowed.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#pipeline_uid ⇒ ::String

Returns Unique identifier of the Delivery Pipeline.

Returns:

  • (::String) —

    Unique identifier of the Delivery Pipeline.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#rule ⇒ ::String

Returns Rule id.

Returns:

  • (::String) —

    Rule id.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#rule_type ⇒ ::String

Returns Rule type (e.g. Restrict Rollouts).

Returns:

  • (::String) —

    Rule type (e.g. Restrict Rollouts).



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#target ⇒ ::String

Returns The name of the Target. This is an optional field, as a Target may not always be applicable to a policy.

Returns:

  • (::String) —

    The name of the Target. This is an optional field, as a Target may not always be applicable to a policy.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#target_uid ⇒ ::String

Returns Unique identifier of the Target. This is an optional field, as a Target may not always be applicable to a policy.

Returns:

  • (::String) —

    Unique identifier of the Target. This is an optional field, as a Target may not always be applicable to a policy.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end

#verdict ⇒ ::Google::Cloud::Deploy::V1::DeployPolicyEvaluationEvent::PolicyVerdict

Returns The policy verdict of the request.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb', line 72

class DeployPolicyEvaluationEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The policy verdict of the request.
  module PolicyVerdict
    # This should never happen.
    POLICY_VERDICT_UNSPECIFIED = 0

    # Allowed by policy. This enum value is not currently used but may be used
    # in the future. Currently logs are only generated when a request is denied
    # by policy.
    ALLOWED_BY_POLICY = 1

    # Denied by policy.
    DENIED_BY_POLICY = 2
  end

  # Things that could have overridden the policy verdict. When overrides are
  # used, the request will be allowed even if it is DENIED_BY_POLICY.
  module PolicyVerdictOverride
    # This should never happen.
    POLICY_VERDICT_OVERRIDE_UNSPECIFIED = 0

    # The policy was overridden.
    POLICY_OVERRIDDEN = 1

    # The policy was suspended.
    POLICY_SUSPENDED = 2
  end
end