Skip to main content

Class: GetAuditLogsRequest

cloudservice.v1.GetAuditLogsRequest

Represents a GetAuditLogsRequest.

Properties​

endTimeExclusive​

• Optional endTimeExclusive: null | $Properties

Filter for UTC time < (defaults to current time) - optional.


pageSize​

• pageSize: number

The requested size of the page to retrieve - optional. Cannot exceed 1000. Defaults to 100.


pageToken​

• pageToken: string

The page token if this is continuing from another response - optional.


startTimeInclusive​

• Optional startTimeInclusive: null | $Properties

Filter for UTC time >= (defaults to 30 days ago) - optional.

Methods​

toJSON​

▸ toJSON(): Object

Converts this GetAuditLogsRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): GetAuditLogsRequest & $Properties

Creates a new GetAuditLogsRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

GetAuditLogsRequest & $Properties

GetAuditLogsRequest instance

▸ create(properties?): GetAuditLogsRequest

Parameters​

NameType
properties?$Properties

Returns​

GetAuditLogsRequest


decode​

▸ decode(reader, length?): GetAuditLogsRequest & $Properties

Decodes a GetAuditLogsRequest message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

GetAuditLogsRequest & $Properties

GetAuditLogsRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): GetAuditLogsRequest & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

GetAuditLogsRequest & $Properties

GetAuditLogsRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode​

▸ encode(message, writer?): Writer

Encodes the specified GetAuditLogsRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetAuditLogsRequest.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesGetAuditLogsRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified GetAuditLogsRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.GetAuditLogsRequest.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesGetAuditLogsRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): GetAuditLogsRequest

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

GetAuditLogsRequest

GetAuditLogsRequest


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageGetAuditLogsRequestGetAuditLogsRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object