Class protos.google.logging.v2.UpdateSinkRequest

Represents an UpdateSinkRequest.

Package

@google-cloud/logging

Constructors

(constructor)(properties)

constructor(properties?: google.logging.v2.IUpdateSinkRequest);

Constructs a new UpdateSinkRequest.

Parameter
NameDescription
properties IUpdateSinkRequest

Properties to set

Properties

sink

public sink?: (google.logging.v2.ILogSink|null);

UpdateSinkRequest sink.

Property Value
TypeDescription
(google.logging.v2.ILogSink|null)

sinkName

public sinkName: string;

UpdateSinkRequest sinkName.

Property Value
TypeDescription
string

uniqueWriterIdentity

public uniqueWriterIdentity: boolean;

UpdateSinkRequest uniqueWriterIdentity.

Property Value
TypeDescription
boolean

updateMask

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

UpdateSinkRequest updateMask.

Property Value
TypeDescription
(google.protobuf.IFieldMask|null)

Methods

create(properties)

public static create(properties?: google.logging.v2.IUpdateSinkRequest): google.logging.v2.UpdateSinkRequest;

Creates a new UpdateSinkRequest instance using the specified properties.

Parameter
NameDescription
properties IUpdateSinkRequest

Properties to set

Returns
TypeDescription
google.logging.v2.UpdateSinkRequest

UpdateSinkRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.logging.v2.UpdateSinkRequest;

Decodes an UpdateSinkRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.logging.v2.UpdateSinkRequest

UpdateSinkRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.logging.v2.UpdateSinkRequest;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.logging.v2.UpdateSinkRequest

UpdateSinkRequest

encode(message, writer)

public static encode(message: google.logging.v2.IUpdateSinkRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UpdateSinkRequest message. Does not implicitly messages.

Parameters
NameDescription
message IUpdateSinkRequest

UpdateSinkRequest 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.logging.v2.IUpdateSinkRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IUpdateSinkRequest

UpdateSinkRequest 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.logging.v2.UpdateSinkRequest;

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

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

Plain object

Returns
TypeDescription
google.logging.v2.UpdateSinkRequest

UpdateSinkRequest

toJSON()

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

Converts this UpdateSinkRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.logging.v2.UpdateSinkRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.logging.v2.UpdateSinkRequest

UpdateSinkRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an UpdateSinkRequest 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