Google Cloud Platform Feeds API

openapi: 3.2.0
info:
  title: Cloud Asset Feeds API
  version: v1
  description: Generated from Google's published Discovery document for Cloud Asset API (cloudasset v1, revision 20261106). 5 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://cloudasset.googleapis.com
tags:
- name: Feeds
paths:
  /v1/{v1Id}/{v1Id1}/feeds:
    post:
      operationId: cloudasset.feeds.create
      summary: Create feeds
      description: Creates a feed in a parent project/folder/organization to listen to its asset updates.
      parameters:
      - name: v1Id
        in: path
        required: true
        description: Resource name segment (v1Id).
        schema:
          type: string
      - name: v1Id1
        in: path
        required: true
        description: Resource name segment (v1Id1).
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFeedRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Feed'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      tags:
      - Feeds
    get:
      operationId: cloudasset.feeds.list
      summary: List feeds
      description: Lists all asset feeds in a parent project/folder/organization.
      parameters:
      - name: v1Id
        in: path
        required: true
        description: Resource name segment (v1Id).
        schema:
          type: string
      - name: v1Id1
        in: path
        required: true
        description: Resource name segment (v1Id1).
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFeedsResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      tags:
      - Feeds
  /v1/{v1Id}/{v1Id1}/feeds/{feedsId}:
    delete:
      operationId: cloudasset.feeds.delete
      summary: Delete feeds
      description: Deletes an asset feed.
      parameters:
      - name: v1Id
        in: path
        required: true
        description: Resource name segment (v1Id).
        schema:
          type: string
      - name: v1Id1
        in: path
        required: true
        description: Resource name segment (v1Id1).
        schema:
          type: string
      - name: feedsId
        in: path
        required: true
        description: Resource name segment (feedsId).
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      tags:
      - Feeds
    get:
      operationId: cloudasset.feeds.get
      summary: Get feeds
      description: Gets details about an asset feed.
      parameters:
      - name: v1Id
        in: path
        required: true
        description: Resource name segment (v1Id).
        schema:
          type: string
      - name: v1Id1
        in: path
        required: true
        description: Resource name segment (v1Id1).
        schema:
          type: string
      - name: feedsId
        in: path
        required: true
        description: Resource name segment (feedsId).
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Feed'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      tags:
      - Feeds
    patch:
      operationId: cloudasset.feeds.patch
      summary: Patch feeds
      description: Updates an asset feed configuration.
      parameters:
      - name: v1Id
        in: path
        required: true
        description: Resource name segment (v1Id).
        schema:
          type: string
      - name: v1Id1
        in: path
        required: true
        description: Resource name segment (v1Id1).
        schema:
          type: string
      - name: feedsId
        in: path
        required: true
        description: Resource name segment (feedsId).
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFeedRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Feed'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
      - apiKey: []
      tags:
      - Feeds
components:
  schemas:
    CreateFeedRequest:
      type: object
      properties:
        feedId:
          type: string
          description: Required. This is the client-assigned asset feed identifier and it needs to be unique under a specific parent project/folder/organization.
        feed:
          $ref: '#/components/schemas/Feed'
          description: 'Required. The feed details. The field `name` must be empty and it will be generated in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id'
      description: Create asset feed request.
    Feed:
      properties:
        assetTypes:
          description: 'A list of types of the assets to receive updates. You must specify either or both of asset_names and asset_types. Only asset updates matching specified asset_names or asset_types are exported to the feed. Example: `"compute.googleapis.com/Disk"` For a list of all supported asset types, see [Supported asset types](/asset-inventory/docs/supported-asset-types).'
          type: array
          items:
            type: string
        assetNames:
          description: 'A list of the full names of the assets to receive updates. You must specify either or both of asset_names and asset_types. Only asset updates matching specified asset_names or asset_types are exported to the feed. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. For a list of the full names for supported asset types, see [Resource name format](/asset-inventory/docs/resource-name-format).'
          items:
            type: string
          type: array
        contentType:
          type: string
          enum:
          - CONTENT_TYPE_UNSPECIFIED
          - RESOURCE
          - IAM_POLICY
          - ORG_POLICY
          - ACCESS_POLICY
          - OS_INVENTORY
          - RELATIONSHIP
          description: Asset content type. If not specified, no content but the asset name and type will be returned.
        feedOutputConfig:
          $ref: '#/components/schemas/FeedOutputConfig'
          description: Required. Feed output configuration defining where the asset updates are published to.
        relationshipTypes:
          type: array
          items:
            type: string
          description: 'A list of relationship types to output, for example: `INSTANCE_TO_INSTANCEGROUP`. This field should only be specified if content_type=RELATIONSHIP. * If specified: it outputs specified relationship updates on the [asset_names] or the [asset_types]. It returns an error if any of the [relationship_types] doesn''t belong to the supported relationship types of the [asset_names] or [asset_types], or any of the [asset_names] or the [asset_types] doesn''t belong to the source types of the [relationship_types]. * Otherwise: it outputs the supported relationships of the types of [asset_names] and [asset_types] or returns an error if any of the [asset_names] or the [asset_types] has no replationship support. See [Introduction to Cloud Asset Inventory](https://cloud.google.com/asset-inventory/docs/overview) for all supported asset types and relationship types.'
        name:
          description: Required. The format will be projects/{project_number}/feeds/{client-assigned_feed_identifier} or folders/{folder_number}/feeds/{client-assigned_feed_identifier} or organizations/{organization_number}/feeds/{client-assigned_feed_identifier} The client-assigned feed identifier must be unique within the parent project/folder/organization.
          type: string
        condition:
          $ref: '#/components/schemas/Expr'
          description: 'A condition which determines whether an asset update should be published. If specified, an asset will be returned only when the expression evaluates to true. When set, `expression` field in the `Expr` must be a valid [CEL expression] (https://github.com/google/cel-spec) on a TemporalAsset with name `temporal_asset`. Example: a Feed with expression ("temporal_asset.deleted == true") will only publish Asset deletions. Other fields of `Expr` are optional. See our [user guide](https://cloud.google.com/asset-inventory/docs/monitoring-asset-changes-with-condition) for detailed instructions.'
      type: object
      description: 'An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Pub/Sub topics.'
    PubsubDestination:
      description: A Pub/Sub destination.
      type: object
      properties:
        topic:
          type: string
          description: 'The name of the Pub/Sub topic to publish to. Example: `projects/PROJECT_ID/topics/TOPIC_ID`.'
    Empty:
      description: 'A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }'
      properties: {}
      type: object
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    UpdateFeedRequest:
      type: object
      description: Update asset feed request.
      properties:
        feed:
          $ref: '#/components/schemas/Feed'
          description: 'Required. The new values of feed details. It must match an existing feed and the field `name` must be in the format of: projects/project_number/feeds/feed_id or folders/folder_number/feeds/feed_id or organizations/organization_number/feeds/feed_id.'
        updateMask:
          type: string
          description: Required. Only updates the `feed` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server.
          format: google-fieldmask
    ListFeedsResponse:
      properties:
        feeds:
          type: array
          description: A list of feeds.
          items:
            $ref: '#/components/schemas/Feed'
      type: object
    Expr:
      description: 'Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != ''private'' && document.type != ''internal''" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "''New message received at '' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.'
      type: object
      properties:
        title:
          description: Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
          type: string
        description:
          description: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
          type: string
        location:
          description: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
          type: string
        expression:
          description: Textual representation of an expression in Common Expression Language syntax.
          type: string
    FeedOutputConfig:
      properties:
        pubsubDestination:
          $ref: '#/components/schemas/PubsubDestination'
          description: Destination on Pub/Sub.
      description: Output configuration for asset feed destination.
      type: object
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    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: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
            https://www.googleapis.com/auth/cloudasset: See, edit, configure, and delete your Google Cloud Asset data and see the email address for your Google Account
externalDocs:
  url: https://cloud.google.com/asset-inventory/docs/quickstart
x-provenance:
  method: harvested
  publisher: Google
  source: https://cloudasset.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261106)