Class protos.google.logging.v2.CreateSinkRequest (10.2.3)

Represents a CreateSinkRequest.

Package

@google-cloud/logging

Constructors

(constructor)(properties)

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

Constructs a new CreateSinkRequest.

Parameter
NameDescription
properties ICreateSinkRequest

Properties to set

Properties

parent

public parent: string;

CreateSinkRequest parent.

sink

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

CreateSinkRequest sink.

uniqueWriterIdentity

public uniqueWriterIdentity: boolean;

CreateSinkRequest uniqueWriterIdentity.

Methods

create(properties)

public static create(properties?: google.logging.v2.ICreateSinkRequest): google.logging.v2.CreateSinkRequest;

Creates a new CreateSinkRequest instance using the specified properties.

Parameter
NameDescription
properties ICreateSinkRequest

Properties to set

Returns
TypeDescription
google.logging.v2.CreateSinkRequest

CreateSinkRequest instance

decode(reader, length)

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

Decodes a CreateSinkRequest 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.CreateSinkRequest

CreateSinkRequest

decodeDelimited(reader)

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

Decodes a CreateSinkRequest 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.CreateSinkRequest

CreateSinkRequest

encode(message, writer)

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

Encodes the specified CreateSinkRequest message. Does not implicitly messages.

Parameters
NameDescription
message ICreateSinkRequest

CreateSinkRequest 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.ICreateSinkRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ICreateSinkRequest

CreateSinkRequest 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.CreateSinkRequest;

Creates a CreateSinkRequest 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.CreateSinkRequest

CreateSinkRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CreateSinkRequest

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.logging.v2.CreateSinkRequest

CreateSinkRequest

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