Class DeployPolicyEvaluationEvent (1.52.0)

public final class DeployPolicyEvaluationEvent extends GeneratedMessageV3 implements DeployPolicyEvaluationEventOrBuilder

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

Protobuf type google.cloud.deploy.v1.DeployPolicyEvaluationEvent

Static Fields

ALLOWED_FIELD_NUMBER

public static final int ALLOWED_FIELD_NUMBER
Field Value
Type Description
int

DELIVERY_PIPELINE_FIELD_NUMBER

public static final int DELIVERY_PIPELINE_FIELD_NUMBER
Field Value
Type Description
int

DEPLOY_POLICY_FIELD_NUMBER

public static final int DEPLOY_POLICY_FIELD_NUMBER
Field Value
Type Description
int

DEPLOY_POLICY_UID_FIELD_NUMBER

public static final int DEPLOY_POLICY_UID_FIELD_NUMBER
Field Value
Type Description
int

INVOKER_FIELD_NUMBER

public static final int INVOKER_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

OVERRIDES_FIELD_NUMBER

public static final int OVERRIDES_FIELD_NUMBER
Field Value
Type Description
int

PIPELINE_UID_FIELD_NUMBER

public static final int PIPELINE_UID_FIELD_NUMBER
Field Value
Type Description
int

RULE_FIELD_NUMBER

public static final int RULE_FIELD_NUMBER
Field Value
Type Description
int

RULE_TYPE_FIELD_NUMBER

public static final int RULE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

TARGET_FIELD_NUMBER

public static final int TARGET_FIELD_NUMBER
Field Value
Type Description
int

TARGET_UID_FIELD_NUMBER

public static final int TARGET_UID_FIELD_NUMBER
Field Value
Type Description
int

VERDICT_FIELD_NUMBER

public static final int VERDICT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DeployPolicyEvaluationEvent getDefaultInstance()
Returns
Type Description
DeployPolicyEvaluationEvent

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DeployPolicyEvaluationEvent.Builder newBuilder()
Returns
Type Description
DeployPolicyEvaluationEvent.Builder

newBuilder(DeployPolicyEvaluationEvent prototype)

public static DeployPolicyEvaluationEvent.Builder newBuilder(DeployPolicyEvaluationEvent prototype)
Parameter
Name Description
prototype DeployPolicyEvaluationEvent
Returns
Type Description
DeployPolicyEvaluationEvent.Builder

parseDelimitedFrom(InputStream input)

public static DeployPolicyEvaluationEvent parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployPolicyEvaluationEvent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DeployPolicyEvaluationEvent parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DeployPolicyEvaluationEvent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DeployPolicyEvaluationEvent parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DeployPolicyEvaluationEvent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DeployPolicyEvaluationEvent parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployPolicyEvaluationEvent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DeployPolicyEvaluationEvent parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeployPolicyEvaluationEvent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DeployPolicyEvaluationEvent parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DeployPolicyEvaluationEvent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployPolicyEvaluationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DeployPolicyEvaluationEvent> parser()
Returns
Type Description
Parser<DeployPolicyEvaluationEvent>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllowed()

public boolean getAllowed()

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

bool allowed = 11;

Returns
Type Description
boolean

The allowed.

getDefaultInstanceForType()

public DeployPolicyEvaluationEvent getDefaultInstanceForType()
Returns
Type Description
DeployPolicyEvaluationEvent

getDeliveryPipeline()

public String getDeliveryPipeline()

The name of the Delivery Pipeline.

string delivery_pipeline = 5;

Returns
Type Description
String

The deliveryPipeline.

getDeliveryPipelineBytes()

public ByteString getDeliveryPipelineBytes()

The name of the Delivery Pipeline.

string delivery_pipeline = 5;

Returns
Type Description
ByteString

The bytes for deliveryPipeline.

getDeployPolicy()

public String getDeployPolicy()

The name of the DeployPolicy.

string deploy_policy = 9;

Returns
Type Description
String

The deployPolicy.

getDeployPolicyBytes()

public ByteString getDeployPolicyBytes()

The name of the DeployPolicy.

string deploy_policy = 9;

Returns
Type Description
ByteString

The bytes for deployPolicy.

getDeployPolicyUid()

public String getDeployPolicyUid()

Unique identifier of the DeployPolicy.

string deploy_policy_uid = 10;

Returns
Type Description
String

The deployPolicyUid.

getDeployPolicyUidBytes()

public ByteString getDeployPolicyUidBytes()

Unique identifier of the DeployPolicy.

string deploy_policy_uid = 10;

Returns
Type Description
ByteString

The bytes for deployPolicyUid.

getInvoker()

public DeployPolicy.Invoker getInvoker()

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

.google.cloud.deploy.v1.DeployPolicy.Invoker invoker = 8;

Returns
Type Description
DeployPolicy.Invoker

The invoker.

getInvokerValue()

public int getInvokerValue()

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

.google.cloud.deploy.v1.DeployPolicy.Invoker invoker = 8;

Returns
Type Description
int

The enum numeric value on the wire for invoker.

getMessage()

public String getMessage()

Debug message for when a deploy policy event occurs.

string message = 1;

Returns
Type Description
String

The message.

getMessageBytes()

public ByteString getMessageBytes()

Debug message for when a deploy policy event occurs.

string message = 1;

Returns
Type Description
ByteString

The bytes for message.

getOverrides(int index)

public DeployPolicyEvaluationEvent.PolicyVerdictOverride getOverrides(int index)

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

repeated .google.cloud.deploy.v1.DeployPolicyEvaluationEvent.PolicyVerdictOverride overrides = 13;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
DeployPolicyEvaluationEvent.PolicyVerdictOverride

The overrides at the given index.

getOverridesCount()

public int getOverridesCount()

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

repeated .google.cloud.deploy.v1.DeployPolicyEvaluationEvent.PolicyVerdictOverride overrides = 13;

Returns
Type Description
int

The count of overrides.

getOverridesList()

public List<DeployPolicyEvaluationEvent.PolicyVerdictOverride> getOverridesList()

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

repeated .google.cloud.deploy.v1.DeployPolicyEvaluationEvent.PolicyVerdictOverride overrides = 13;

Returns
Type Description
List<PolicyVerdictOverride>

A list containing the overrides.

getOverridesValue(int index)

public int getOverridesValue(int index)

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

repeated .google.cloud.deploy.v1.DeployPolicyEvaluationEvent.PolicyVerdictOverride overrides = 13;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of overrides at the given index.

getOverridesValueList()

public List<Integer> getOverridesValueList()

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

repeated .google.cloud.deploy.v1.DeployPolicyEvaluationEvent.PolicyVerdictOverride overrides = 13;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for overrides.

getParserForType()

public Parser<DeployPolicyEvaluationEvent> getParserForType()
Returns
Type Description
Parser<DeployPolicyEvaluationEvent>
Overrides

getPipelineUid()

public String getPipelineUid()

Unique identifier of the Delivery Pipeline.

string pipeline_uid = 4;

Returns
Type Description
String

The pipelineUid.

getPipelineUidBytes()

public ByteString getPipelineUidBytes()

Unique identifier of the Delivery Pipeline.

string pipeline_uid = 4;

Returns
Type Description
ByteString

The bytes for pipelineUid.

getRule()

public String getRule()

Rule id.

string rule = 3;

Returns
Type Description
String

The rule.

getRuleBytes()

public ByteString getRuleBytes()

Rule id.

string rule = 3;

Returns
Type Description
ByteString

The bytes for rule.

getRuleType()

public String getRuleType()

Rule type (e.g. Restrict Rollouts).

string rule_type = 2;

Returns
Type Description
String

The ruleType.

getRuleTypeBytes()

public ByteString getRuleTypeBytes()

Rule type (e.g. Restrict Rollouts).

string rule_type = 2;

Returns
Type Description
ByteString

The bytes for ruleType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTarget()

public String getTarget()

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

string target = 7;

Returns
Type Description
String

The target.

getTargetBytes()

public ByteString getTargetBytes()

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

string target = 7;

Returns
Type Description
ByteString

The bytes for target.

getTargetUid()

public String getTargetUid()

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

string target_uid = 6;

Returns
Type Description
String

The targetUid.

getTargetUidBytes()

public ByteString getTargetUidBytes()

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

string target_uid = 6;

Returns
Type Description
ByteString

The bytes for targetUid.

getVerdict()

public DeployPolicyEvaluationEvent.PolicyVerdict getVerdict()

The policy verdict of the request.

.google.cloud.deploy.v1.DeployPolicyEvaluationEvent.PolicyVerdict verdict = 12;

Returns
Type Description
DeployPolicyEvaluationEvent.PolicyVerdict

The verdict.

getVerdictValue()

public int getVerdictValue()

The policy verdict of the request.

.google.cloud.deploy.v1.DeployPolicyEvaluationEvent.PolicyVerdict verdict = 12;

Returns
Type Description
int

The enum numeric value on the wire for verdict.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DeployPolicyEvaluationEvent.Builder newBuilderForType()
Returns
Type Description
DeployPolicyEvaluationEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DeployPolicyEvaluationEvent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DeployPolicyEvaluationEvent.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DeployPolicyEvaluationEvent.Builder toBuilder()
Returns
Type Description
DeployPolicyEvaluationEvent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException