LogBucket

google.logging.v2. LogBucket

Represents a LogBucket.

Constructor

new LogBucket(propertiesopt)

Constructs a new LogBucket.

Parameters:
Name Type Attributes Description
properties google.logging.v2.ILogBucket <optional>

Properties to set

Implements:
  • ILogBucket

Members

analyticsEnabled

LogBucket analyticsEnabled.

cmekSettings

LogBucket cmekSettings.

createTime

LogBucket createTime.

description

LogBucket description.

indexConfigs

LogBucket indexConfigs.

lifecycleState

LogBucket lifecycleState.

locked

LogBucket locked.

name

LogBucket name.

restrictedFields

LogBucket restrictedFields.

retentionDays

LogBucket retentionDays.

updateTime

LogBucket updateTime.

Methods

toJSON() → {Object.<string, *>}

Converts this LogBucket to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.logging.v2.LogBucket}

Creates a new LogBucket instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.logging.v2.ILogBucket <optional>

Properties to set

Returns:
Type Description
google.logging.v2.LogBucket

LogBucket instance

(static) decode(reader, lengthopt) → {google.logging.v2.LogBucket}

Decodes a LogBucket message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.logging.v2.LogBucket

LogBucket

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.logging.v2.LogBucket}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.logging.v2.LogBucket

LogBucket

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified LogBucket message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.logging.v2.ILogBucket

LogBucket message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.logging.v2.ILogBucket

LogBucket message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.logging.v2.LogBucket}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.logging.v2.LogBucket

LogBucket

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for LogBucket

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.logging.v2.LogBucket

LogBucket

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a LogBucket message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not