Class protos.google.cloud.compute.v1.SignedUrlKey (4.5.0)

Represents a SignedUrlKey.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.ISignedUrlKey);

Constructs a new SignedUrlKey.

Parameter
Name Description
properties ISignedUrlKey

Properties to set

Properties

_keyName

public _keyName?: "keyName";

SignedUrlKey _keyName.

_keyValue

public _keyValue?: "keyValue";

SignedUrlKey _keyValue.

keyName

public keyName?: (string|null);

SignedUrlKey keyName.

keyValue

public keyValue?: (string|null);

SignedUrlKey keyValue.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.ISignedUrlKey): google.cloud.compute.v1.SignedUrlKey;

Creates a new SignedUrlKey instance using the specified properties.

Parameter
Name Description
properties ISignedUrlKey

Properties to set

Returns
Type Description
SignedUrlKey

SignedUrlKey instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.SignedUrlKey;

Decodes a SignedUrlKey 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
SignedUrlKey

SignedUrlKey

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.SignedUrlKey;

Decodes a SignedUrlKey message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SignedUrlKey

SignedUrlKey

encode(message, writer)

public static encode(message: google.cloud.compute.v1.ISignedUrlKey, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SignedUrlKey message. Does not implicitly messages.

Parameters
Name Description
message ISignedUrlKey

SignedUrlKey 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.ISignedUrlKey, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SignedUrlKey message, length delimited. Does not implicitly messages.

Parameters
Name Description
message ISignedUrlKey

SignedUrlKey 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.SignedUrlKey;

Creates a SignedUrlKey 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
SignedUrlKey

SignedUrlKey

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for SignedUrlKey

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 SignedUrlKey to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.compute.v1.SignedUrlKey, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a SignedUrlKey message. Also converts values to other types if specified.

Parameters
Name Description
message SignedUrlKey

SignedUrlKey

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 SignedUrlKey message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not