Class ManualApprovals (0.5.0)

public final class ManualApprovals extends GeneratedMessageV3 implements ManualApprovalsOrBuilder

A manual approval workflow where users who are designated as approvers need to call the ApproveGrant/DenyGrant APIs for a grant. The workflow can consist of multiple serial steps where each step defines who can act as approver in that step and how many of those users should approve before the workflow moves to the next step.

This can be used to create approval workflows such as:

  • Require an approval from any user in a group G.
  • Require an approval from any k number of users from a Group G.
  • Require an approval from any user in a group G and then from a user U.

    A single user might be part of the approvers ACL for multiple steps in this workflow, but they can only approve once and that approval is only considered to satisfy the approval step at which it was granted.

Protobuf type google.cloud.privilegedaccessmanager.v1.ManualApprovals

Static Fields

REQUIRE_APPROVER_JUSTIFICATION_FIELD_NUMBER

public static final int REQUIRE_APPROVER_JUSTIFICATION_FIELD_NUMBER
Field Value
Type Description
int

STEPS_FIELD_NUMBER

public static final int STEPS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ManualApprovals getDefaultInstance()
Returns
Type Description
ManualApprovals

getDescriptor()

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

newBuilder()

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

newBuilder(ManualApprovals prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ManualApprovals getDefaultInstanceForType()
Returns
Type Description
ManualApprovals

getParserForType()

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

getRequireApproverJustification()

public boolean getRequireApproverJustification()

Optional. Do the approvers need to provide a justification for their actions?

bool require_approver_justification = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The requireApproverJustification.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSteps(int index)

public ManualApprovals.Step getSteps(int index)

Optional. List of approval steps in this workflow. These steps are followed in the specified order sequentially. Only 1 step is supported.

repeated .google.cloud.privilegedaccessmanager.v1.ManualApprovals.Step steps = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ManualApprovals.Step

getStepsCount()

public int getStepsCount()

Optional. List of approval steps in this workflow. These steps are followed in the specified order sequentially. Only 1 step is supported.

repeated .google.cloud.privilegedaccessmanager.v1.ManualApprovals.Step steps = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getStepsList()

public List<ManualApprovals.Step> getStepsList()

Optional. List of approval steps in this workflow. These steps are followed in the specified order sequentially. Only 1 step is supported.

repeated .google.cloud.privilegedaccessmanager.v1.ManualApprovals.Step steps = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Step>

getStepsOrBuilder(int index)

public ManualApprovals.StepOrBuilder getStepsOrBuilder(int index)

Optional. List of approval steps in this workflow. These steps are followed in the specified order sequentially. Only 1 step is supported.

repeated .google.cloud.privilegedaccessmanager.v1.ManualApprovals.Step steps = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ManualApprovals.StepOrBuilder

getStepsOrBuilderList()

public List<? extends ManualApprovals.StepOrBuilder> getStepsOrBuilderList()

Optional. List of approval steps in this workflow. These steps are followed in the specified order sequentially. Only 1 step is supported.

repeated .google.cloud.privilegedaccessmanager.v1.ManualApprovals.Step steps = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.privilegedaccessmanager.v1.ManualApprovals.StepOrBuilder>

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 ManualApprovals.Builder newBuilderForType()
Returns
Type Description
ManualApprovals.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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