Represents an ApprovalRequest.
Package
@google-cloud/access-approvalConstructors
(constructor)(properties)
constructor(properties?: google.cloud.accessapproval.v1.IApprovalRequest);Constructs a new ApprovalRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IApprovalRequest
Properties to set |
Properties
approve
public approve?: (google.cloud.accessapproval.v1.IApproveDecision|null);ApprovalRequest approve.
decision
public decision?: ("approve"|"dismiss");ApprovalRequest decision.
dismiss
public dismiss?: (google.cloud.accessapproval.v1.IDismissDecision|null);ApprovalRequest dismiss.
name
public name: string;ApprovalRequest name.
requestedExpiration
public requestedExpiration?: (google.protobuf.ITimestamp|null);ApprovalRequest requestedExpiration.
requestedLocations
public requestedLocations?: (google.cloud.accessapproval.v1.IAccessLocations|null);ApprovalRequest requestedLocations.
requestedReason
public requestedReason?: (google.cloud.accessapproval.v1.IAccessReason|null);ApprovalRequest requestedReason.
requestedResourceName
public requestedResourceName: string;ApprovalRequest requestedResourceName.
requestedResourceProperties
public requestedResourceProperties?: (google.cloud.accessapproval.v1.IResourceProperties|null);ApprovalRequest requestedResourceProperties.
requestTime
public requestTime?: (google.protobuf.ITimestamp|null);ApprovalRequest requestTime.
Methods
create(properties)
public static create(properties?: google.cloud.accessapproval.v1.IApprovalRequest): google.cloud.accessapproval.v1.ApprovalRequest;Creates a new ApprovalRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IApprovalRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.accessapproval.v1.ApprovalRequest | ApprovalRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.accessapproval.v1.ApprovalRequest;Decodes an ApprovalRequest message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.cloud.accessapproval.v1.ApprovalRequest | ApprovalRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.accessapproval.v1.ApprovalRequest;Decodes an ApprovalRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.cloud.accessapproval.v1.ApprovalRequest | ApprovalRequest |
encode(message, writer)
public static encode(message: google.cloud.accessapproval.v1.IApprovalRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ApprovalRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IApprovalRequest
ApprovalRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.accessapproval.v1.IApprovalRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ApprovalRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IApprovalRequest
ApprovalRequest message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.accessapproval.v1.ApprovalRequest;Creates an ApprovalRequest message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
google.cloud.accessapproval.v1.ApprovalRequest | ApprovalRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ApprovalRequest
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this ApprovalRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.accessapproval.v1.ApprovalRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an ApprovalRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.accessapproval.v1.ApprovalRequest
ApprovalRequest |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an ApprovalRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|