Console
    Contact Us Start free

    REST Resource: locations.buckets

    Resource: LogBucket

    Describes a repository in which log entries are stored.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "retentionDays" 
 : 
 integer 
 , 
 "locked" 
 : 
 boolean 
 , 
 "lifecycleState" 
 : 
 enum (  LifecycleState 
 
) 
 , 
 "analyticsEnabled" 
 : 
 boolean 
 , 
 "restrictedFields" 
 : 
 [ 
 string 
 ] 
 , 
 "indexConfigs" 
 : 
 [ 
 { 
 object (  IndexConfig 
 
) 
 } 
 ] 
 , 
 "cmekSettings" 
 : 
 { 
 object (  CmekSettings 
 
) 
 } 
 }
    Fields
    name

    string

    Output only. The resource name of the bucket.

    For example:

    projects/my-project/locations/global/buckets/my-bucket

    For a list of supported locations, see Supported Regions

    For the location of global it is unspecified where log entries are actually stored.

    After a bucket has been created, the location cannot be changed.
    description

    string

    Optional. Describes this bucket.
    createTime

    string ( Timestamp format)

    Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    updateTime

    string ( Timestamp format)

    Output only. The last update timestamp of the bucket.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    retentionDays

    integer

    Optional. Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
    locked

    boolean

    Optional. Whether the bucket is locked.

    The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
    lifecycleState

    enum ( LifecycleState )

    Output only. The bucket lifecycle state.
    analyticsEnabled

    boolean

    Optional. Whether log analytics is enabled for this bucket.

    Once enabled, log analytics features cannot be disabled.
    restrictedFields[]

    string

    Optional. Log entry field paths that are denied access in this bucket.

    The following fields and their children are eligible: textPayload , jsonPayload , protoPayload , httpRequest , labels , sourceLocation .

    Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz )
    indexConfigs[]

    object ( IndexConfig )

    Optional. A list of indexed fields and related configuration data.
    cmekSettings

    object ( CmekSettings )

    Optional. The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.

    Methods

    create

    		Creates a log bucket that can be used to store log entries.

    createAsync

    		Creates a log bucket asynchronously that can be used to store log entries.

    delete

    		Deletes a log bucket.

    get

    		Gets a log bucket.

    list

    		Lists log buckets.

    patch

    		Updates a log bucket.

    undelete

    		Undeletes a log bucket.

    updateAsync

    		Updates a log bucket asynchronously.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: