Class protos.google.monitoring.dashboard.v1.CreateDashboardRequest

Represents a CreateDashboardRequest.

Package

@google-cloud/monitoring-dashboards!

Constructors

(constructor)(properties)

constructor(properties?: google.monitoring.dashboard.v1.ICreateDashboardRequest);

Constructs a new CreateDashboardRequest.

Parameter
Type Name Description
ICreateDashboardRequest properties

Properties to set

Properties

dashboard

public dashboard?: (google.monitoring.dashboard.v1.IDashboard|null);

CreateDashboardRequest dashboard.

Property Value
Type Description
(google.monitoring.dashboard.v1.IDashboard|null)

parent

public parent: string;

CreateDashboardRequest parent.

Property Value
Type Description
string

validateOnly

public validateOnly: boolean;

CreateDashboardRequest validateOnly.

Property Value
Type Description
boolean

Methods

create(properties)

public static create(properties?: google.monitoring.dashboard.v1.ICreateDashboardRequest): google.monitoring.dashboard.v1.CreateDashboardRequest;

Creates a new CreateDashboardRequest instance using the specified properties.

Parameter
Type Name Description
ICreateDashboardRequest properties

Properties to set
Returns
Type Description
google.monitoring.dashboard.v1.CreateDashboardRequest

CreateDashboardRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.dashboard.v1.CreateDashboardRequest;

Decodes a CreateDashboardRequest message from the specified reader or buffer.

Parameters
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
number length

Message length if known beforehand
Returns
Type Description
google.monitoring.dashboard.v1.CreateDashboardRequest

CreateDashboardRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.dashboard.v1.CreateDashboardRequest;

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

Parameter
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
Returns
Type Description
google.monitoring.dashboard.v1.CreateDashboardRequest

CreateDashboardRequest

encode(message, writer)

public static encode(message: google.monitoring.dashboard.v1.ICreateDashboardRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CreateDashboardRequest message. Does not implicitly messages.

Parameters
Type Name Description
ICreateDashboardRequest message

CreateDashboardRequest message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.monitoring.dashboard.v1.ICreateDashboardRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Type Name Description
ICreateDashboardRequest message

CreateDashboardRequest message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.monitoring.dashboard.v1.CreateDashboardRequest;

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

Parameter
Type Name Description
{ [k: string]: any } object

Plain object
Returns
Type Description
google.monitoring.dashboard.v1.CreateDashboardRequest

CreateDashboardRequest

toJSON()

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

Converts this CreateDashboardRequest to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Type Name Description
google.monitoring.dashboard.v1.CreateDashboardRequest message

CreateDashboardRequest
$protobuf.IConversionOptions options

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

Plain object

verify(message)

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

Verifies a CreateDashboardRequest message.

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

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not