Documentation

Google_Service_Logging_Resource_FoldersLocationsBuckets extends Google_Service_Resource
in package

Application

The "buckets" collection of methods.

Typical usage is: $loggingService = new Google_Service_Logging(...); $buckets = $loggingService->buckets;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Logging_LogBucket: Creates a bucket that can be used to store log entries. Once a bucket has been created, the region cannot be changed. (buckets.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Logging_LoggingEmpty: Deletes a bucket. Moves the bucket to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all logs in the bucket will be permanently deleted. (buckets.delete)
get() : Google_Service_Logging_LogBucket: Gets a bucket (Beta). (buckets.get)
listFoldersLocationsBuckets() : Google_Service_Logging_ListBucketsResponse: Lists buckets (Beta). (buckets.listFoldersLocationsBuckets)
patch() : Google_Service_Logging_LogBucket: Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta. (buckets.patch)
undelete() : Google_Service_Logging_LoggingEmpty: Undeletes a bucket. A bucket that has been deleted may be undeleted within the grace period of 7 days. (buckets.undelete)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a bucket that can be used to store log entries. Once a bucket has been created, the region cannot be changed. (buckets.create)


    public
                create(string $parent, Google_Service_Logging_LogBucket $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LogBucket

Parameters

$parent : string: Required. The resource in which to create the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" Example: "projects/my- logging-project/locations/global"
$postBody : Google_Service_Logging_LogBucket
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Logging_LogBucket —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes a bucket. Moves the bucket to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all logs in the bucket will be permanently deleted. (buckets.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LoggingEmpty

Parameters

$name : string: 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]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id".
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Logging_LoggingEmpty —

get()

Gets a bucket (Beta). (buckets.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LogBucket

Parameters

$name : string: 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]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id".
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Logging_LogBucket —

listFoldersLocationsBuckets()

Lists buckets (Beta). (buckets.listFoldersLocationsBuckets)


    public
                listFoldersLocationsBuckets(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_ListBucketsResponse

Parameters

$parent : string: 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.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Logging_ListBucketsResponse —

patch()

Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta. (buckets.patch)


    public
                patch(string $name, Google_Service_Logging_LogBucket $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LogBucket

Parameters

$name : string: 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]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property
$postBody : Google_Service_Logging_LogBucket
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Logging_LogBucket —

undelete()

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


    public
                undelete(string $name, Google_Service_Logging_UndeleteBucketRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Logging_LoggingEmpty

Parameters

$name : string: 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]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id".
$postBody : Google_Service_Logging_UndeleteBucketRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Logging_LoggingEmpty —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —