Class protos.google.cloud.apphub.v1.WorkloadReference (0.1.0)

Represents a WorkloadReference.

Package

@google-cloud/apphub

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.apphub.v1.IWorkloadReference);

Constructs a new WorkloadReference.

Parameter
NameDescription
properties IWorkloadReference

Properties to set

Properties

uri

public uri: string;

WorkloadReference uri.

Methods

create(properties)

public static create(properties?: google.cloud.apphub.v1.IWorkloadReference): google.cloud.apphub.v1.WorkloadReference;

Creates a new WorkloadReference instance using the specified properties.

Parameter
NameDescription
properties IWorkloadReference

Properties to set

Returns
TypeDescription
WorkloadReference

WorkloadReference instance

decode(reader, length)

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

Decodes a WorkloadReference message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
WorkloadReference

WorkloadReference

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
WorkloadReference

WorkloadReference

encode(message, writer)

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

Encodes the specified WorkloadReference message. Does not implicitly messages.

Parameters
NameDescription
message IWorkloadReference

WorkloadReference message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.apphub.v1.IWorkloadReference, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IWorkloadReference

WorkloadReference message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.apphub.v1.WorkloadReference;

Creates a WorkloadReference message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
WorkloadReference

WorkloadReference

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for WorkloadReference

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this WorkloadReference to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message WorkloadReference

WorkloadReference

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a WorkloadReference message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not