Class ApprovalRequest (2.56.0) 

public final class ApprovalRequest extends GeneratedMessageV3 implements ApprovalRequestOrBuilder

A request for the customer to approve access to a resource.

Protobuf type google.cloud.accessapproval.v1.ApprovalRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ApprovalRequest

Static Fields

APPROVE_FIELD_NUMBER

public static final int APPROVE_FIELD_NUMBER
Field Value
Type Description
int

DISMISS_FIELD_NUMBER

public static final int DISMISS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REQUESTED_EXPIRATION_FIELD_NUMBER

public static final int REQUESTED_EXPIRATION_FIELD_NUMBER
Field Value
Type Description
int

REQUESTED_LOCATIONS_FIELD_NUMBER

public static final int REQUESTED_LOCATIONS_FIELD_NUMBER
Field Value
Type Description
int

REQUESTED_REASON_FIELD_NUMBER

public static final int REQUESTED_REASON_FIELD_NUMBER
Field Value
Type Description
int

REQUESTED_RESOURCE_NAME_FIELD_NUMBER

public static final int REQUESTED_RESOURCE_NAME_FIELD_NUMBER
Field Value
Type Description
int

REQUESTED_RESOURCE_PROPERTIES_FIELD_NUMBER

public static final int REQUESTED_RESOURCE_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_TIME_FIELD_NUMBER

public static final int REQUEST_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ApprovalRequest getDefaultInstance()
Returns
Type Description
ApprovalRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ApprovalRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getApprove()

public ApproveDecision getApprove()

Access was approved.

.google.cloud.accessapproval.v1.ApproveDecision approve = 7;

Returns
Type Description
ApproveDecision

The approve.

getApproveOrBuilder()

public ApproveDecisionOrBuilder getApproveOrBuilder()

Access was approved.

.google.cloud.accessapproval.v1.ApproveDecision approve = 7;

Returns
Type Description
ApproveDecisionOrBuilder

getDecisionCase()

public ApprovalRequest.DecisionCase getDecisionCase()
Returns
Type Description
ApprovalRequest.DecisionCase

getDefaultInstanceForType()

public ApprovalRequest getDefaultInstanceForType()
Returns
Type Description
ApprovalRequest

getDismiss()

public DismissDecision getDismiss()

The request was dismissed.

.google.cloud.accessapproval.v1.DismissDecision dismiss = 8;

Returns
Type Description
DismissDecision

The dismiss.

getDismissOrBuilder()

public DismissDecisionOrBuilder getDismissOrBuilder()

The request was dismissed.

.google.cloud.accessapproval.v1.DismissDecision dismiss = 8;

Returns
Type Description
DismissDecisionOrBuilder

getName()

public String getName()

The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getRequestTime()

public Timestamp getRequestTime()

The time at which approval was requested.

.google.protobuf.Timestamp request_time = 5;

Returns
Type Description
Timestamp

The requestTime.

getRequestTimeOrBuilder()

public TimestampOrBuilder getRequestTimeOrBuilder()

The time at which approval was requested.

.google.protobuf.Timestamp request_time = 5;

Returns
Type Description
TimestampOrBuilder

getRequestedExpiration()

public Timestamp getRequestedExpiration()

The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time.

.google.protobuf.Timestamp requested_expiration = 6;

Returns
Type Description
Timestamp

The requestedExpiration.

getRequestedExpirationOrBuilder()

public TimestampOrBuilder getRequestedExpirationOrBuilder()

The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time.

.google.protobuf.Timestamp requested_expiration = 6;

Returns
Type Description
TimestampOrBuilder

getRequestedLocations()

public AccessLocations getRequestedLocations()

The locations for which approval is being requested.

.google.cloud.accessapproval.v1.AccessLocations requested_locations = 4;

Returns
Type Description
AccessLocations

The requestedLocations.

getRequestedLocationsOrBuilder()

public AccessLocationsOrBuilder getRequestedLocationsOrBuilder()

The locations for which approval is being requested.

.google.cloud.accessapproval.v1.AccessLocations requested_locations = 4;

Returns
Type Description
AccessLocationsOrBuilder

getRequestedReason()

public AccessReason getRequestedReason()

The justification for which approval is being requested.

.google.cloud.accessapproval.v1.AccessReason requested_reason = 3;

Returns
Type Description
AccessReason

The requestedReason.

getRequestedReasonOrBuilder()

public AccessReasonOrBuilder getRequestedReasonOrBuilder()

The justification for which approval is being requested.

.google.cloud.accessapproval.v1.AccessReason requested_reason = 3;

Returns
Type Description
AccessReasonOrBuilder

getRequestedResourceName()

public String getRequestedResourceName()

The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.

string requested_resource_name = 2;

Returns
Type Description
String

The requestedResourceName.

getRequestedResourceNameBytes()

public ByteString getRequestedResourceNameBytes()

The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.

string requested_resource_name = 2;

Returns
Type Description
ByteString

The bytes for requestedResourceName.

getRequestedResourceProperties()

public ResourceProperties getRequestedResourceProperties()

Properties related to the resource represented by requested_resource_name.

.google.cloud.accessapproval.v1.ResourceProperties requested_resource_properties = 9;

Returns
Type Description
ResourceProperties

The requestedResourceProperties.

getRequestedResourcePropertiesOrBuilder()

public ResourcePropertiesOrBuilder getRequestedResourcePropertiesOrBuilder()

Properties related to the resource represented by requested_resource_name.

.google.cloud.accessapproval.v1.ResourceProperties requested_resource_properties = 9;

Returns
Type Description
ResourcePropertiesOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasApprove()

public boolean hasApprove()

Access was approved.

.google.cloud.accessapproval.v1.ApproveDecision approve = 7;

Returns
Type Description
boolean

Whether the approve field is set.

hasDismiss()

public boolean hasDismiss()

The request was dismissed.

.google.cloud.accessapproval.v1.DismissDecision dismiss = 8;

Returns
Type Description
boolean

Whether the dismiss field is set.

hasRequestTime()

public boolean hasRequestTime()

The time at which approval was requested.

.google.protobuf.Timestamp request_time = 5;

Returns
Type Description
boolean

Whether the requestTime field is set.

hasRequestedExpiration()

public boolean hasRequestedExpiration()

The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time.

.google.protobuf.Timestamp requested_expiration = 6;

Returns
Type Description
boolean

Whether the requestedExpiration field is set.

hasRequestedLocations()

public boolean hasRequestedLocations()

The locations for which approval is being requested.

.google.cloud.accessapproval.v1.AccessLocations requested_locations = 4;

Returns
Type Description
boolean

Whether the requestedLocations field is set.

hasRequestedReason()

public boolean hasRequestedReason()

The justification for which approval is being requested.

.google.cloud.accessapproval.v1.AccessReason requested_reason = 3;

Returns
Type Description
boolean

Whether the requestedReason field is set.

hasRequestedResourceProperties()

public boolean hasRequestedResourceProperties()

Properties related to the resource represented by requested_resource_name.

.google.cloud.accessapproval.v1.ResourceProperties requested_resource_properties = 9;

Returns
Type Description
boolean

Whether the requestedResourceProperties field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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