Method: googleapis.integrations.v1.projects.locations.integrations.versions.archive

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the locked_by user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.

Arguments

Parameters
name	string Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
location	string Location of the HTTP endpoint. For example, if location is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. If not set, the global endpint will be used. See service endpoints.

Raised exceptions

Exceptions
ConnectionError	In case of a network problem (such as DNS failure or refused connection).
HttpError	If the response status is >= 400 (excluding 429 and 503).
TimeoutError	If a long-running operation takes longer to finish than the specified timeout limit.
TypeError	If an operation or function receives an argument of the wrong type.
ValueError	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response will be empty.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- archive:
    call: googleapis.integrations.v1.projects.locations.integrations.versions.archive
    args:
        name: ...
    result: archiveResult

JSON

[
  {
    "archive": {
      "call": "googleapis.integrations.v1.projects.locations.integrations.versions.archive",
      "args": {
        "name": "..."
      },
      "result": "archiveResult"
    }
  }
]