1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Logging
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsBuckets

ProjectsLocationsBuckets

class ProjectsLocationsBuckets extends Resource (View source)

The "buckets" collection of methods.

Typical usage is:

 $loggingService = new Google\Service\Logging(...);
 $buckets = $loggingService->projects_locations_buckets;

Methods

LogBucket
create(string $parent, LogBucket $postBody, array $optParams = [])

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. (buckets.create)

Operation
createAsync(string $parent, LogBucket $postBody, array $optParams = [])

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. (buckets.createAsync)

LoggingEmpty
delete(string $name, array $optParams = [])

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. (buckets.delete)

LogBucket
get(string $name, array $optParams = [])

Gets a log bucket. (buckets.get)

ListBucketsResponse
listProjectsLocationsBuckets(string $parent, array $optParams = [])

Lists log buckets. (buckets.listProjectsLocationsBuckets)

LogBucket
patch(string $name, LogBucket $postBody, array $optParams = [])

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. (buckets.patch)

LoggingEmpty
undelete(string $name, UndeleteBucketRequest $postBody, array $optParams = [])

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

Operation
updateAsync(string $name, LogBucket $postBody, array $optParams = [])

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.

Details

at line 53
LogBucket create(string $parent, LogBucket $postBody, array $optParams = [])

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. (buckets.create)

Parameters

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"
LogBucket $postBody
array $optParams

Optional parameters.

Return Value

LogBucket

Exceptions

Exception

at line 77
Operation createAsync(string $parent, LogBucket $postBody, array $optParams = [])

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. (buckets.createAsync)

Parameters

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"
LogBucket $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 98
LoggingEmpty delete(string $name, array $optParams = [])

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. (buckets.delete)

Parameters

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"
array $optParams

Optional parameters.

Return Value

LoggingEmpty

Exceptions

Exception

at line 117
LogBucket get(string $name, array $optParams = [])

Gets a log bucket. (buckets.get)

Parameters

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"
array $optParams

Optional parameters.

Return Value

LogBucket

Exceptions

Exception

at line 145
ListBucketsResponse listProjectsLocationsBuckets(string $parent, array $optParams = [])

Lists log buckets. (buckets.listProjectsLocationsBuckets)

Parameters

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.
array $optParams

Optional parameters.

Return Value

ListBucketsResponse

Exceptions

Exception

at line 175
LogBucket patch(string $name, LogBucket $postBody, array $optParams = [])

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. (buckets.patch)

Parameters

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"
LogBucket $postBody
array $optParams

Optional parameters.

Return Value

LogBucket

Exceptions

Exception

at line 196
LoggingEmpty undelete(string $name, UndeleteBucketRequest $postBody, array $optParams = [])

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

Parameters

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"
UndeleteBucketRequest $postBody
array $optParams

Optional parameters.

Return Value

LoggingEmpty

Exceptions

Exception

at line 227
Operation updateAsync(string $name, LogBucket $postBody, array $optParams = [])

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.

(buckets.updateAsync)

Parameters

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"
LogBucket $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception