Google Cloud Storage Anywhere Caches API

openapi: 3.2.0
info:
  title: Cloud Storage JSON Anywhere Caches 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: anywhereCaches
paths:
  /storage/v1/b/{bucket}/anywhereCaches:
    post:
      operationId: storage.anywhereCaches.insert
      tags:
      - anywhereCaches
      summary: Creates an Anywhere Cache instance
      description: Creates an Anywhere Cache instance.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: Name of the parent bucket.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnywhereCache'
      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/devstorage.full_control
        - https://www.googleapis.com/auth/devstorage.read_write
    get:
      operationId: storage.anywhereCaches.list
      tags:
      - anywhereCaches
      summary: Returns a list of Anywhere Cache instances of the bucket matching the criteria
      description: Returns a list of Anywhere Cache instances of the bucket matching the criteria.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: Name of the parent bucket.
      - name: pageSize
        in: query
        required: false
        schema:
          type: integer
          format: int32
        description: Maximum number of items to return in a single page of responses. Maximum 1000.
      - 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/AnywhereCaches'
        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}/anywhereCaches/{anywhereCacheId}:
    patch:
      operationId: storage.anywhereCaches.update
      tags:
      - anywhereCaches
      summary: Updates the config of an Anywhere Cache instance
      description: Updates the config of an Anywhere Cache instance.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: Name of the parent bucket.
      - name: anywhereCacheId
        in: path
        required: true
        schema:
          type: string
        description: The ID of requested Anywhere Cache instance.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnywhereCache'
      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/devstorage.full_control
        - https://www.googleapis.com/auth/devstorage.read_write
    get:
      operationId: storage.anywhereCaches.get
      tags:
      - anywhereCaches
      summary: Returns the metadata of an Anywhere Cache instance
      description: Returns the metadata of an Anywhere Cache instance.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: Name of the parent bucket.
      - name: anywhereCacheId
        in: path
        required: true
        schema:
          type: string
        description: The ID of requested Anywhere Cache instance.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnywhereCache'
        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}/anywhereCaches/{anywhereCacheId}/pause:
    post:
      operationId: storage.anywhereCaches.pause
      tags:
      - anywhereCaches
      summary: Pauses an Anywhere Cache instance
      description: Pauses an Anywhere Cache instance.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: Name of the parent bucket.
      - name: anywhereCacheId
        in: path
        required: true
        schema:
          type: string
        description: The ID of requested Anywhere Cache instance.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnywhereCache'
        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}/anywhereCaches/{anywhereCacheId}/resume:
    post:
      operationId: storage.anywhereCaches.resume
      tags:
      - anywhereCaches
      summary: Resumes a paused or disabled Anywhere Cache instance
      description: Resumes a paused or disabled Anywhere Cache instance.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: Name of the parent bucket.
      - name: anywhereCacheId
        in: path
        required: true
        schema:
          type: string
        description: The ID of requested Anywhere Cache instance.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnywhereCache'
        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}/anywhereCaches/{anywhereCacheId}/disable:
    post:
      operationId: storage.anywhereCaches.disable
      tags:
      - anywhereCaches
      summary: Disables an Anywhere Cache instance
      description: Disables an Anywhere Cache instance.
      parameters:
      - name: bucket
        in: path
        required: true
        schema:
          type: string
        description: Name of the parent bucket.
      - name: anywhereCacheId
        in: path
        required: true
        schema:
          type: string
        description: The ID of requested Anywhere Cache instance.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnywhereCache'
        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
components:
  schemas:
    AnywhereCache:
      type: object
      description: An Anywhere Cache instance.
      properties:
        kind:
          type: string
          description: The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache.
          default: storage#anywhereCache
        id:
          type: string
          description: The ID of the resource, including the project number, bucket name and anywhere cache ID.
        selfLink:
          type: string
          description: The link to this cache instance.
        bucket:
          type: string
          description: The name of the bucket containing this cache instance.
        anywhereCacheId:
          type: string
          description: The ID of the Anywhere cache instance.
        zone:
          type: string
          description: The zone in which the cache instance is running. For example, us-central1-a.
        state:
          type: string
          description: The current state of the cache instance.
        createTime:
          type: string
          description: The creation time of the cache instance in RFC 3339 format.
          format: date-time
        updateTime:
          type: string
          description: The modification time of the cache instance metadata in RFC 3339 format.
          format: date-time
        ttl:
          type: string
          description: 'The TTL of all cache entries in whole seconds. e.g., "7200s". '
          format: google-duration
        admissionPolicy:
          type: string
          description: The cache-level entry admission policy.
        pendingUpdate:
          type: boolean
          description: True if the cache instance has an active Update long-running operation.
        ingestOnWrite:
          type: boolean
          description: Specifies whether objects are ingested into the cache upon write.
    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.
    AnywhereCaches:
      type: object
      description: A list of Anywhere Caches.
      properties:
        kind:
          type: string
          description: The kind of item this is. For lists of Anywhere Caches, this is always storage#anywhereCaches.
          default: storage#anywhereCaches
        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.
        items:
          type: array
          description: The list of items.
          items:
            $ref: '#/components/schemas/AnywhereCache'
    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
  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