Show / Hide Table of Contents

Class LocationsResource.BucketsResource

The "buckets" collection of methods.

Inheritance
object
LocationsResource.BucketsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Logging.v2
Assembly: Google.Apis.Logging.v2.dll
Syntax
public class LocationsResource.BucketsResource

Constructors

BucketsResource(IClientService)

Constructs a new resource.

Declaration
public BucketsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Links

Gets the Links resource.

Declaration
public virtual LocationsResource.BucketsResource.LinksResource Links { get; }
Property Value
Type Description
LocationsResource.BucketsResource.LinksResource

Views

Gets the Views resource.

Declaration
public virtual LocationsResource.BucketsResource.ViewsResource Views { get; }
Property Value
Type Description
LocationsResource.BucketsResource.ViewsResource

Methods

Create(LogBucket, string)

Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.

Declaration
public virtual LocationsResource.BucketsResource.CreateRequest Create(LogBucket body, string parent)
Parameters
Type Name Description
LogBucket body

The body of the request.

string parent

Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global"

Returns
Type Description
LocationsResource.BucketsResource.CreateRequest

CreateAsync(LogBucket, string)

Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed.

Declaration
public virtual LocationsResource.BucketsResource.CreateAsyncRequest CreateAsync(LogBucket body, string parent)
Parameters
Type Name Description
LogBucket body

The body of the request.

string parent

Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global"

Returns
Type Description
LocationsResource.BucketsResource.CreateAsyncRequest

Delete(string)

Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.

Declaration
public virtual LocationsResource.BucketsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The full resource name of the bucket to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket"

Returns
Type Description
LocationsResource.BucketsResource.DeleteRequest

Get(string)

Gets a log bucket.

Declaration
public virtual LocationsResource.BucketsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket"

Returns
Type Description
LocationsResource.BucketsResource.GetRequest

List(string)

Lists log buckets.

Declaration
public virtual LocationsResource.BucketsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets.

Returns
Type Description
LocationsResource.BucketsResource.ListRequest

Patch(LogBucket, string)

Updates a log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed.

Declaration
public virtual LocationsResource.BucketsResource.PatchRequest Patch(LogBucket body, string name)
Parameters
Type Name Description
LogBucket body

The body of the request.

string name

Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket"

Returns
Type Description
LocationsResource.BucketsResource.PatchRequest

Undelete(UndeleteBucketRequest, string)

Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.

Declaration
public virtual LocationsResource.BucketsResource.UndeleteRequest Undelete(UndeleteBucketRequest body, string name)
Parameters
Type Name Description
UndeleteBucketRequest body

The body of the request.

string name

Required. The full resource name of the bucket to undelete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket"

Returns
Type Description
LocationsResource.BucketsResource.UndeleteRequest

UpdateAsync(LogBucket, string)

Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed.

Declaration
public virtual LocationsResource.BucketsResource.UpdateAsyncRequest UpdateAsync(LogBucket body, string name)
Parameters
Type Name Description
LogBucket body

The body of the request.

string name

Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket"

Returns
Type Description
LocationsResource.BucketsResource.UpdateAsyncRequest
In this article
Back to top Generated by DocFX