Class protos.google.cloud.batch.v1.LogsPolicy (1.15.0)

Represents a LogsPolicy.

Package

@google-cloud/batch

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.batch.v1.ILogsPolicy);

Constructs a new LogsPolicy.

Parameter
Name Description
properties ILogsPolicy

Properties to set

Properties

cloudLoggingOption

public cloudLoggingOption?: (google.cloud.batch.v1.LogsPolicy.ICloudLoggingOption|null);

LogsPolicy cloudLoggingOption.

destination

public destination: (google.cloud.batch.v1.LogsPolicy.Destination|keyof typeof google.cloud.batch.v1.LogsPolicy.Destination);

LogsPolicy destination.

logsPath

public logsPath: string;

LogsPolicy logsPath.

Methods

create(properties)

public static create(properties?: google.cloud.batch.v1.ILogsPolicy): google.cloud.batch.v1.LogsPolicy;

Creates a new LogsPolicy instance using the specified properties.

Parameter
Name Description
properties ILogsPolicy

Properties to set

Returns
Type Description
LogsPolicy

LogsPolicy instance

decode(reader, length)

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

Decodes a LogsPolicy message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
LogsPolicy

LogsPolicy

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
LogsPolicy

LogsPolicy

encode(message, writer)

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

Encodes the specified LogsPolicy message. Does not implicitly messages.

Parameters
Name Description
message ILogsPolicy

LogsPolicy 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: google.cloud.batch.v1.ILogsPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ILogsPolicy

LogsPolicy 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 }): google.cloud.batch.v1.LogsPolicy;

Creates a LogsPolicy 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
LogsPolicy

LogsPolicy

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for LogsPolicy

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

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

Converts this LogsPolicy to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message LogsPolicy

LogsPolicy

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 a LogsPolicy 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