API hub API . projects . locations . generatedSpecApis

close()

Close httplib2 connections.

generateSpec(name, body=None, x__xgafv=None)

Merges the per-day stored specs across the requested window and returns the merged OpenAPI document. Preview: this method is in Public Preview. Behavior and the API surface may change until the Spec Generation feature reaches General Availability.

Args:
  name: string, Required. The resource name of the GeneratedSpecApi to generate from. Format: `projects/{project}/locations/{location}/generatedSpecApis/{generated_spec_api}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for GenerateSpec.
  "observationWindow": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Required. The observation window. The server quantizes to day boundaries and caps the span at 90 days.
    "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for GenerateSpec.
  "generatedSpec": { # The spec contents. # The merged OpenAPI document for the requested window.
    "contents": "A String", # Required. The contents of the spec. The contents should be base64 encoded while calling the OnePlatform APIs like CreateSpec, UpdateSpec and CollectApiData.
    "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
  },
}

get(name, x__xgafv=None)

Gets a single GeneratedSpecApi by resource name. Preview: this method is in Public Preview. Behavior and the API surface may change until the Spec Generation feature reaches General Availability.

Args:
  name: string, Required. The resource name of the GeneratedSpecApi to retrieve. Format: `projects/{project}/locations/{location}/generatedSpecApis/{generated_spec_api}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An API the pipeline is tracking for spec generation.
  "api": "A String", # Output only. The full resource name of the associated catalog API. Format: `projects/{project}/locations/{location}/apis/{api}`
  "createTime": "A String", # Output only. The time at which the resource was created.
  "deployment": "A String", # Output only. The full resource name of the associated catalog Deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
  "displayName": "A String", # Output only. Human-readable display name; server-derived.
  "lastSpecGeneratedTime": "A String", # Output only. The time at which the most recent spec was generated. Unset while `state == SPEC_API_REGISTERED`.
  "name": "A String", # Identifier. The full resource name. The trailing segment is the pipeline-generated identifier. Format: `projects/{project}/locations/{location}/generatedSpecApis/{generated_spec_api}`
  "source": { # User-facing collapse of the source-side identity tuple. # Output only. Where the pipeline observed this API.
    "sourceDisplayName": "A String", # Output only. Per-source instance label (e.g. "/" for Apigee X).
    "type": "A String", # Output only. The source type.
    "typeDisplayName": "A String", # Output only. Server-supplied label (e.g. "Apigee X").
  },
  "spec": "A String", # Output only. The full resource name of the associated catalog Spec; populated only when `state == SPEC_ASSOCIATED`. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
  "state": "A String", # Output only. The current lifecycle state.
  "updateTime": "A String", # Output only. The time at which the resource was last updated.
  "version": "A String", # Output only. The full resource name of the associated catalog Version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the APIs the pipeline is tracking, ordered by `update_time desc`. Preview: this method is in Public Preview. Behavior and the API surface may change until the Spec Generation feature reaches General Availability.

Args:
  parent: string, Required. The parent resource, which owns this collection of tracked APIs. Format: `projects/{project}/locations/{location}` (required)
  filter: string, Optional. An AIP-160 filter. This release supports the fields `state` and `source.source_type`, the `=` comparison operator only, and `AND` conjunction only. Examples: - `state = "SPEC_GENERATED"` - `state = "SPEC_ASSOCIATED" AND source.source_type = APIGEE_X`
  pageSize: integer, Optional. The maximum number of results to return. The service may return fewer. If unspecified, at most 50 will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListGeneratedSpecApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except `page_size`) provided to `ListGeneratedSpecApis` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListGeneratedSpecApis.
  "generatedSpecApis": [ # The tracked APIs for the requested parent, ordered by `update_time desc`.
    { # An API the pipeline is tracking for spec generation.
      "api": "A String", # Output only. The full resource name of the associated catalog API. Format: `projects/{project}/locations/{location}/apis/{api}`
      "createTime": "A String", # Output only. The time at which the resource was created.
      "deployment": "A String", # Output only. The full resource name of the associated catalog Deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
      "displayName": "A String", # Output only. Human-readable display name; server-derived.
      "lastSpecGeneratedTime": "A String", # Output only. The time at which the most recent spec was generated. Unset while `state == SPEC_API_REGISTERED`.
      "name": "A String", # Identifier. The full resource name. The trailing segment is the pipeline-generated identifier. Format: `projects/{project}/locations/{location}/generatedSpecApis/{generated_spec_api}`
      "source": { # User-facing collapse of the source-side identity tuple. # Output only. Where the pipeline observed this API.
        "sourceDisplayName": "A String", # Output only. Per-source instance label (e.g. "/" for Apigee X).
        "type": "A String", # Output only. The source type.
        "typeDisplayName": "A String", # Output only. Server-supplied label (e.g. "Apigee X").
      },
      "spec": "A String", # Output only. The full resource name of the associated catalog Spec; populated only when `state == SPEC_ASSOCIATED`. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
      "state": "A String", # Output only. The current lifecycle state.
      "updateTime": "A String", # Output only. The time at which the resource was last updated.
      "version": "A String", # Output only. The full resource name of the associated catalog Version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results; empty when there are no more results.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.