Class protos.grafeas.v1.UpdateNoteRequest (3.4.6)

Represents an UpdateNoteRequest.

Package

@google-cloud/grafeas!

Constructors

(constructor)(properties)

constructor(properties?: grafeas.v1.IUpdateNoteRequest);

Constructs a new UpdateNoteRequest.

Parameter

Name	Description
properties	`grafeas.v1.IUpdateNoteRequest` Properties to set

Properties

name

public name: string;

UpdateNoteRequest name.

Property Value

Type	Description
string

note

public note?: (grafeas.v1.INote|null);

UpdateNoteRequest note.

Property Value

Type	Description
(grafeas.v1.INote\|null)

updateMask

public updateMask?: (google.protobuf.IFieldMask|null);

UpdateNoteRequest updateMask.

Property Value

Type	Description
(google.protobuf.IFieldMask\|null)

Methods

create(properties)

public static create(properties?: grafeas.v1.IUpdateNoteRequest): grafeas.v1.UpdateNoteRequest;

Creates a new UpdateNoteRequest instance using the specified properties.

Parameter

Name	Description
properties	`grafeas.v1.IUpdateNoteRequest` Properties to set

Returns

Type	Description
grafeas.v1.UpdateNoteRequest	UpdateNoteRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): grafeas.v1.UpdateNoteRequest;

Decodes an UpdateNoteRequest message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
grafeas.v1.UpdateNoteRequest	UpdateNoteRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): grafeas.v1.UpdateNoteRequest;

Decodes an UpdateNoteRequest message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
grafeas.v1.UpdateNoteRequest	UpdateNoteRequest

encode(message, writer)

public static encode(message: grafeas.v1.IUpdateNoteRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UpdateNoteRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`grafeas.v1.IUpdateNoteRequest` UpdateNoteRequest 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: grafeas.v1.IUpdateNoteRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`grafeas.v1.IUpdateNoteRequest` UpdateNoteRequest 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 }): grafeas.v1.UpdateNoteRequest;

Creates an UpdateNoteRequest 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
grafeas.v1.UpdateNoteRequest	UpdateNoteRequest

toJSON()

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

Converts this UpdateNoteRequest to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: grafeas.v1.UpdateNoteRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	`grafeas.v1.UpdateNoteRequest` UpdateNoteRequest
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 an UpdateNoteRequest 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