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

Represents a CopyLogEntriesMetadata.

Package

Constructors

(constructor)(properties)

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

Constructs a new CopyLogEntriesMetadata.

Parameter

Name	Description
properties	`ICopyLogEntriesMetadata` Properties to set

Properties

cancellationRequested

public cancellationRequested: boolean;

CopyLogEntriesMetadata cancellationRequested.

endTime

public endTime?: (google.protobuf.ITimestamp|null);

CopyLogEntriesMetadata endTime.

progress

public progress: number;

CopyLogEntriesMetadata progress.

request

public request?: (google.logging.v2.ICopyLogEntriesRequest|null);

CopyLogEntriesMetadata request.

startTime

public startTime?: (google.protobuf.ITimestamp|null);

CopyLogEntriesMetadata startTime.

state

public state: (google.logging.v2.OperationState|keyof typeof google.logging.v2.OperationState);

CopyLogEntriesMetadata state.

writerIdentity

public writerIdentity: string;

CopyLogEntriesMetadata writerIdentity.

Methods

create(properties)

public static create(properties?: google.logging.v2.ICopyLogEntriesMetadata): google.logging.v2.CopyLogEntriesMetadata;

Creates a new CopyLogEntriesMetadata instance using the specified properties.

Parameter

Name	Description
properties	`ICopyLogEntriesMetadata` Properties to set

Returns

Type	Description
google.logging.v2.CopyLogEntriesMetadata	CopyLogEntriesMetadata instance

decode(reader, length)

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

Decodes a CopyLogEntriesMetadata 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
google.logging.v2.CopyLogEntriesMetadata	CopyLogEntriesMetadata

decodeDelimited(reader)

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

Decodes a CopyLogEntriesMetadata 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
google.logging.v2.CopyLogEntriesMetadata	CopyLogEntriesMetadata

encode(message, writer)

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

Encodes the specified CopyLogEntriesMetadata message. Does not implicitly messages.

Parameters

Name	Description
message	`ICopyLogEntriesMetadata` CopyLogEntriesMetadata 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.logging.v2.ICopyLogEntriesMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`ICopyLogEntriesMetadata` CopyLogEntriesMetadata 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.logging.v2.CopyLogEntriesMetadata;

Creates a CopyLogEntriesMetadata 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
google.logging.v2.CopyLogEntriesMetadata	CopyLogEntriesMetadata

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CopyLogEntriesMetadata

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

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.logging.v2.CopyLogEntriesMetadata` CopyLogEntriesMetadata
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 CopyLogEntriesMetadata 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