Class protos.google.cloud.config.v1.PreviewResult (0.2.0)

Represents a PreviewResult.

Package

@google-cloud/config

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.config.v1.IPreviewResult);

Constructs a new PreviewResult.

Parameter
NameDescription
properties IPreviewResult

Properties to set

Properties

binarySignedUri

public binarySignedUri: string;

PreviewResult binarySignedUri.

jsonSignedUri

public jsonSignedUri: string;

PreviewResult jsonSignedUri.

Methods

create(properties)

public static create(properties?: google.cloud.config.v1.IPreviewResult): google.cloud.config.v1.PreviewResult;

Creates a new PreviewResult instance using the specified properties.

Parameter
NameDescription
properties IPreviewResult

Properties to set

Returns
TypeDescription
PreviewResult

PreviewResult instance

decode(reader, length)

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

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

PreviewResult

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
PreviewResult

PreviewResult

encode(message, writer)

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

Encodes the specified PreviewResult message. Does not implicitly messages.

Parameters
NameDescription
message IPreviewResult

PreviewResult 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.config.v1.IPreviewResult, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IPreviewResult

PreviewResult 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.config.v1.PreviewResult;

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

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

Plain object

Returns
TypeDescription
PreviewResult

PreviewResult

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PreviewResult

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message PreviewResult

PreviewResult

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 PreviewResult 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