Google Cloud Storage Operations API

openapi: 3.2.0
info:
  title: Cloud Storage JSON Operations API
  description: Stores and retrieves potentially large, immutable data objects.
  version: v1
  x-discovery-revision: '20261030'
  termsOfService: https://developers.google.com/terms/
  contact:
    name: Google Cloud Storage
    url: https://developers.google.com/storage/docs/json_api/
  x-generated-from: google-discovery
  x-source: https://storage.googleapis.com/$discovery/rest?version=v1
  x-conversion: mechanical Discovery-to-OpenAPI conversion by API Evangelist; every path, parameter and schema is copied from the provider Discovery document
servers:
- url: https://storage.googleapis.com
security:
- oauth2:
  - https://www.googleapis.com/auth/cloud-platform
  - https://www.googleapis.com/auth/cloud-platform.read-only
  - https://www.googleapis.com/auth/devstorage.full_control
  - https://www.googleapis.com/auth/devstorage.read_only
  - https://www.googleapis.com/auth/devstorage.read_write
tags:
- name: Operations
paths:
  /storage/v1/b/{bucket}/operations/{operationId}/cancel:
    post:
      operationId: storage.buckets.operations.cancel
      tags:
      - Operations
      summary: Starts asynchronous cancellation on a long-running operation
      description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: The parent bucket of the operation resource.
      - name: operationId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the operation resource.
      responses:
        '200':
          description: Successful response
        default:
          description: Error response
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/devstorage.full_control
        - https://www.googleapis.com/auth/devstorage.read_write
  /storage/v1/b/{bucket}/operations/{operationId}:
    get:
      operationId: storage.buckets.operations.get
      tags:
      - Operations
      summary: Gets the latest state of a long-running operation
      description: Gets the latest state of a long-running operation.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: The parent bucket of the operation resource.
      - name: operationId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the operation resource.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleLongrunningOperation'
        default:
          description: Error response
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/cloud-platform.read-only
        - https://www.googleapis.com/auth/devstorage.full_control
        - https://www.googleapis.com/auth/devstorage.read_only
        - https://www.googleapis.com/auth/devstorage.read_write
  /storage/v1/b/{bucket}/operations/{operationId}/advanceRelocateBucket:
    post:
      operationId: storage.buckets.operations.advanceRelocateBucket
      tags:
      - Operations
      summary: Starts asynchronous advancement of the relocate bucket operation in the case of…
      description: Starts asynchronous advancement of the relocate bucket operation in the case of required write downtime, to allow it to lock the bucket at the source location, and proceed with the bucket location swap. The server makes a best effort to advance the relocate bucket operation, but success is not guaranteed.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: Name of the bucket to advance the relocate for.
      - name: operationId
        in: path
        required: true
        schema:
          type: string
        description: ID of the operation resource.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdvanceRelocateBucketOperationRequest'
      responses:
        '200':
          description: Successful response
        default:
          description: Error response
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/devstorage.full_control
        - https://www.googleapis.com/auth/devstorage.read_write
  /storage/v1/b/{bucket}/operations:
    get:
      operationId: storage.buckets.operations.list
      tags:
      - Operations
      summary: Lists operations that match the specified filter in the request
      description: Lists operations that match the specified filter in the request.
      parameters:
      - name: filter
        in: query
        required: false
        schema:
          type: string
        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).
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: Name of the bucket in which to look for operations.
      - name: pageSize
        in: query
        required: false
        schema:
          type: integer
          format: int32
        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.
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
        description: A previously-returned page token representing part of the larger set of results to view.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse'
        default:
          description: Error response
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/cloud-platform.read-only
        - https://www.googleapis.com/auth/devstorage.full_control
        - https://www.googleapis.com/auth/devstorage.read_only
        - https://www.googleapis.com/auth/devstorage.read_write
components:
  schemas:
    GoogleRpcStatus:
      type: object
      description: 'The "Status" type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each "Status" message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
      properties:
        code:
          type: integer
          description: The status code, which should be an enum value of google.rpc.Code.
          format: int32
        details:
          type: array
          description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
          items:
            type: object
            additionalProperties:
              description: Properties of the object. Contains field @type with type URL.
        message:
          type: string
          description: A developer-facing error message, which should be in English.
    AdvanceRelocateBucketOperationRequest:
      type: object
      description: An AdvanceRelocateBucketOperation request.
      properties:
        ttl:
          type: string
          description: Specifies the duration after which the relocation will revert to the sync stage if the relocation hasn't succeeded. Optional, if not supplied, a default value of 12h will be used.
          format: google-duration
        expireTime:
          type: string
          description: Specifies the time when the relocation will revert to the sync stage if the relocation hasn't succeeded.
          format: date-time
    GoogleLongrunningOperation:
      type: object
      description: This resource represents a long-running operation that is the result of a network API call.
      properties:
        done:
          type: boolean
          description: If the value is "false", it means the operation is still in progress. If "true", the operation is completed, and either "error" or "response" is available.
        error:
          $ref: '#/components/schemas/GoogleRpcStatus'
        metadata:
          type: object
          description: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
          additionalProperties:
            description: Properties of the object. Contains field @type with type URL.
        name:
          type: string
          description: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the "name" should be a resource name ending with "operations/{operationId}".
        response:
          type: object
          description: The normal response of the operation in case of success. If the original method returns no data on success, such as "Delete", the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type "XxxResponse", where "Xxx" is the original method name. For example, if the original method name is "TakeSnapshot()", the inferred response type is "TakeSnapshotResponse".
          additionalProperties:
            description: Properties of the object. Contains field @type with type URL.
        selfLink:
          type: string
          description: The link to this long running operation.
        kind:
          type: string
          description: The kind of item this is. For operations, this is always storage#operation.
          default: storage#operation
    GoogleLongrunningListOperationsResponse:
      type: object
      description: The response message for storage.buckets.operations.list.
      properties:
        nextPageToken:
          type: string
          description: The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
        operations:
          type: array
          description: A list of operations that matches the specified filter in the request.
          items:
            $ref: '#/components/schemas/GoogleLongrunningOperation'
        kind:
          type: string
          description: The kind of item this is. For lists of operations, this is always storage#operations.
          default: storage#operations
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services
            https://www.googleapis.com/auth/cloud-platform.read-only: View your data across Google Cloud Platform services
            https://www.googleapis.com/auth/devstorage.full_control: Manage your data and permissions in Google Cloud Storage
            https://www.googleapis.com/auth/devstorage.read_only: View your data in Google Cloud Storage
            https://www.googleapis.com/auth/devstorage.read_write: Manage your data in Google Cloud Storage