2023-09-10
▼ ▲ storage.objects.get
Parameters:
softDeleted
Type: boolean
Description: If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.
Location: query
▼ ▲ storage.objects.list
Parameters:
softDeleted
Type: boolean
Description: If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.
Location: query
▼ ▲ storage.buckets.operations.cancel
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.
Path: b/{bucket}/operations/{operationId}/cancel
HTTP Method: POST
Parameter Order:
Parameters:
bucket
Description: The parent bucket of the operation resource.
Location: path
Required: Yes
Type: string
operationId
Description: The ID of the operation resource.
Location: path
Required: Yes
Type: string
Scopes:
▼ ▲ storage.buckets.operations.get
Description: Gets the latest state of a long-running operation.
Path: b/{bucket}/operations/{operationId}
HTTP Method: GET
Parameter Order:
Parameters:
bucket
Description: The parent bucket of the operation resource.
Location: path
Required: Yes
Type: string
operationId
Description: The ID of the operation resource.
Location: path
Required: Yes
Type: string
Scopes:
▼ ▲ storage.buckets.operations.list
Description: Lists operations that match the specified filter in the request.
Path: b/{bucket}/operations
HTTP Method: GET
Parameter Order: bucket
Parameters:
filter
Description: A filter to narrow down results to a preferred subset. The filtering language is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location: query
Type: string
bucket
Description: Name of the bucket in which to look for operations.
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of items to return in a single page of responses. Fewer total results may be returned than requested. The service uses this parameter or 100 items, whichever is smaller.
Minimum: 0
Format: int32
Location: query
Type: integer
pageToken
Description: A previously-returned page token representing part of the larger set of results to view.
Location: query
Type: string
Scopes:
▼ ▲ storage.objects.restore
Path: b/{bucket}/o/{object}/restore
HTTP Method: POST
Description: Restores a soft-deleted object.
Parameters:
bucket
Type: string
Description: Name of the bucket in which the object resides.
Required: Yes
Location: path
generation
Type: string
Description: Selects a specific revision of this object.
Required: Yes
Format: int64
Location: query
object
Type: string
Description: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
Required: Yes
Location: path
ifGenerationMatch
Type: string
Description: Makes the operation conditional on whether the object's one live generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
Format: int64
Location: query
ifGenerationNotMatch
Type: string
Description: Makes the operation conditional on whether none of the object's live generations match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
Format: int64
Location: query
ifMetagenerationMatch
Type: string
Description: Makes the operation conditional on whether the object's one live metageneration matches the given value.
Format: int64
Location: query
ifMetagenerationNotMatch
Type: string
Description: Makes the operation conditional on whether none of the object's live metagenerations match the given value.
Format: int64
Location: query
projection
Type: string
Description: Set of properties to return. Defaults to full.
Enum:
Enum Descriptions:
Location: query
userProject
Type: string
Description: The project to be billed for this request. Required for Requester Pays buckets.
Location: query
Parameter Order:
Scopes:
▼ ▲ storage.objects.bulkRestore
Path: b/{bucket}/o/bulkRestore
HTTP Method: POST
Description: Initiates a long-running bulk restore operation on the specified bucket.
Parameters:
bucket
Type: string
Description: Name of the bucket in which the object resides.
Required: Yes
Location: path
Parameter Order: bucket
Scopes:
▼ ▲ storage.buckets.operations.cancel
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.
Path: b/{bucket}/operations/{operationId}/cancel
HTTP Method: POST
Parameter Order:
Parameters:
bucket
Description: The parent bucket of the operation resource.
Location: path
Required: Yes
Type: string
operationId
Description: The ID of the operation resource.
Location: path
Required: Yes
Type: string
Scopes:
▼ ▲ storage.buckets.operations.get
Description: Gets the latest state of a long-running operation.
Path: b/{bucket}/operations/{operationId}
HTTP Method: GET
Parameter Order:
Parameters:
bucket
Description: The parent bucket of the operation resource.
Location: path
Required: Yes
Type: string
operationId
Description: The ID of the operation resource.
Location: path
Required: Yes
Type: string
Scopes:
▼ ▲ storage.buckets.operations.list
Description: Lists operations that match the specified filter in the request.
Path: b/{bucket}/operations
HTTP Method: GET
Parameter Order: bucket
Parameters:
filter
Description: A filter to narrow down results to a preferred subset. The filtering language is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location: query
Type: string
bucket
Description: Name of the bucket in which to look for operations.
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of items to return in a single page of responses. Fewer total results may be returned than requested. The service uses this parameter or 100 items, whichever is smaller.
Minimum: 0
Format: int32
Location: query
Type: integer
pageToken
Description: A previously-returned page token representing part of the larger set of results to view.
Location: query
Type: string
Scopes:
▼ ▲ storage.objects.restore
Path: b/{bucket}/o/{object}/restore
HTTP Method: POST
Description: Restores a soft-deleted object.
Parameters:
bucket
Type: string
Description: Name of the bucket in which the object resides.
Required: Yes
Location: path
generation
Type: string
Description: Selects a specific revision of this object.
Required: Yes
Format: int64
Location: query
object
Type: string
Description: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
Required: Yes
Location: path
ifGenerationMatch
Type: string
Description: Makes the operation conditional on whether the object's one live generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
Format: int64
Location: query
ifGenerationNotMatch
Type: string
Description: Makes the operation conditional on whether none of the object's live generations match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
Format: int64
Location: query
ifMetagenerationMatch
Type: string
Description: Makes the operation conditional on whether the object's one live metageneration matches the given value.
Format: int64
Location: query
ifMetagenerationNotMatch
Type: string
Description: Makes the operation conditional on whether none of the object's live metagenerations match the given value.
Format: int64
Location: query
projection
Type: string
Description: Set of properties to return. Defaults to full.
Enum:
Enum Descriptions:
Location: query
userProject
Type: string
Description: The project to be billed for this request. Required for Requester Pays buckets.
Location: query
Parameter Order:
Scopes:
▼ ▲ storage.objects.bulkRestore
Path: b/{bucket}/o/bulkRestore
HTTP Method: POST
Description: Initiates a long-running bulk restore operation on the specified bucket.
Parameters:
bucket
Type: string
Description: Name of the bucket in which the object resides.
Required: Yes
Location: path
Parameter Order: bucket
Scopes:
▼ ▲ storage.objects.get
Parameters:
softDeleted
Type: boolean
Description: If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.
Location: query
▼ ▲ storage.objects.list
Parameters:
softDeleted
Type: boolean
Description: If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.
Location: query