Represents a AWSV4Signature.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1.IAWSV4Signature);Constructs a new AWSV4Signature.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAWSV4Signature
Properties to set |
Properties
_accessKey
public _accessKey?: "accessKey";AWSV4Signature _accessKey.
_accessKeyId
public _accessKeyId?: "accessKeyId";AWSV4Signature _accessKeyId.
_accessKeyVersion
public _accessKeyVersion?: "accessKeyVersion";AWSV4Signature _accessKeyVersion.
_originRegion
public _originRegion?: "originRegion";AWSV4Signature _originRegion.
accessKey
public accessKey?: (string|null);AWSV4Signature accessKey.
accessKeyId
public accessKeyId?: (string|null);AWSV4Signature accessKeyId.
accessKeyVersion
public accessKeyVersion?: (string|null);AWSV4Signature accessKeyVersion.
originRegion
public originRegion?: (string|null);AWSV4Signature originRegion.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1.IAWSV4Signature): google.cloud.compute.v1.AWSV4Signature;Creates a new AWSV4Signature instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAWSV4Signature
Properties to set |
| Returns | |
|---|---|
| Type | Description |
AWSV4Signature | AWSV4Signature instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.AWSV4Signature;Decodes a AWSV4Signature message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
AWSV4Signature | AWSV4Signature |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.AWSV4Signature;Decodes a AWSV4Signature message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
AWSV4Signature | AWSV4Signature |
encode(message, writer)
public static encode(message: google.cloud.compute.v1.IAWSV4Signature, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AWSV4Signature message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAWSV4Signature
AWSV4Signature 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.compute.v1.IAWSV4Signature, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AWSV4Signature message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAWSV4Signature
AWSV4Signature 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.compute.v1.AWSV4Signature;Creates a AWSV4Signature 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 |
AWSV4Signature | AWSV4Signature |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for AWSV4Signature
| 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 AWSV4Signature to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.compute.v1.AWSV4Signature, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a AWSV4Signature message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
AWSV4Signature
AWSV4Signature |
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 a AWSV4Signature message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|