Google Cloud Support API (cloudsupport:v2beta)

2023-03-30

18 new methods | 2 updated methods | 10 removed methods

Additions

    Methods
  • cloudsupport.organizations.cases.escalate

      Parameters:

        name

          Type: string

          Description: Required. The fully qualified name of the Case resource to be escalated.

          Pattern: ^organizations/[^/]+/cases/[^/]+$

          Location: path

          Required: Yes

      Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}:escalate

      Path: v2beta/{+name}:escalate

      HTTP Method: POST

      Description: Escalate a case. Escalating a case will initiate the Cloud Support escalation management process. This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • cloudsupport.organizations.cases.list

      HTTP Method: GET

      Parameter Order: parent

      Description: Retrieve all cases under the specified parent. Note: Listing cases under an Organization returns only the cases directly parented by that organization. To retrieve all cases under an organization, including cases parented by projects under that organization, use `cases.search`.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        pageToken

          Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.

          Location: query

          Type: string

        pageSize

          Format: int32

          Location: query

          Type: integer

          Description: The maximum number of cases fetched with each request. Defaults to 10.

        parent

          Required: Yes

          Location: path

          Description: Required. The fully qualified name of parent resource to list cases under.

          Pattern: ^organizations/[^/]+$

          Type: string

        filter

          Type: string

          Location: query

          Description: An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases. Filter expressions use the following fields with the operators equals (`=`) and `AND`: - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - [DEPRECATED] `severity`: The accepted values are `S0`, `S1`, `S2`, `S3`, or `S4`. - `creator.email`: The email address of the case creator. Examples: - `state=CLOSED` - `state=OPEN AND creator.email="tester@example.com"` - `state=OPEN AND (priority=P0 OR priority=P1)`

      Path: v2beta/{+parent}/cases

      Flat Path: v2beta/organizations/{organizationsId}/cases

  • cloudsupport.organizations.cases.get

      HTTP Method: GET

      Description: Retrieve the specified case.

      Parameters:

        name

          Pattern: ^organizations/[^/]+/cases/[^/]+$

          Description: Required. The fully qualified name of a case to be retrieved.

          Location: path

          Required: Yes

          Type: string

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}

      Parameter Order: name

      Path: v2beta/{+name}

  • cloudsupport.organizations.cases.create

      Parameter Order: parent

      Parameters:

        parent

          Pattern: ^organizations/[^/]+$

          Location: path

          Description: Required. The name of the Cloud resource under which the case should be created.

          Required: Yes

          Type: string

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Create a new case and associate it with the given Cloud resource. The case object must have the following fields set: display_name, description, classification, and severity.

      Flat Path: v2beta/organizations/{organizationsId}/cases

      HTTP Method: POST

      Path: v2beta/{+parent}/cases

  • cloudsupport.organizations.cases.close

      Description: Close the specified case.

      Parameters:

        name

          Type: string

          Description: Required. The fully qualified name of the case resource to be closed.

          Pattern: ^organizations/[^/]+/cases/[^/]+$

          Location: path

          Required: Yes

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}:close

      Parameter Order: name

      Path: v2beta/{+name}:close

      HTTP Method: POST

  • cloudsupport.organizations.cases.attachments.list

      HTTP Method: GET

      Path: v2beta/{+parent}/attachments

      Parameters:

        parent

          Pattern: ^organizations/[^/]+/cases/[^/]+$

          Location: path

          Type: string

          Description: Required. The resource name of Case object for which attachments should be listed.

          Required: Yes

        pageSize

          Format: int32

          Location: query

          Description: The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be returned is 100.

          Type: integer

        pageToken

          Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.

          Location: query

          Type: string

      Description: Retrieve all attachments associated with a support case.

      Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}/attachments

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

  • cloudsupport.organizations.cases.comments.list

      Path: v2beta/{+parent}/comments

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

      Description: Retrieve all Comments associated with the Case object.

      Parameters:

        pageSize

          Format: int32

          Location: query

          Type: integer

          Description: The maximum number of comments fetched with each request. Defaults to 10.

        pageToken

          Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.

          Location: query

          Type: string

        parent

          Required: Yes

          Type: string

          Location: path

          Pattern: ^organizations/[^/]+/cases/[^/]+$

          Description: Required. The resource name of Case object for which comments should be listed.

      Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}/comments

  • cloudsupport.organizations.cases.comments.create

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

      Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}/comments

      Description: Add a new comment to the specified Case. The comment object must have the following fields set: body.

      Parameters:

        parent

          Location: path

          Type: string

          Pattern: ^organizations/[^/]+/cases/[^/]+$

          Description: Required. The resource name of Case to which this comment should be added.

          Required: Yes

      Path: v2beta/{+parent}/comments

      HTTP Method: POST

  • cloudsupport.organizations.updateCases

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: PATCH

      Path: v2beta/{+name}

      Parameters:

        name

          Type: string

          Location: path

          Required: Yes

          Pattern: ^organizations/[^/]+/cases$

          Description: The resource name for the case.

        updateMask

          Type: string

          Description: A list of attributes of the case object that should be updated as part of this request. Supported values are severity, display_name, and subscriber_email_addresses. If no fields are specified, all supported fields are updated. WARNING: If you do not provide a field mask, then you may accidentally clear some fields. For example, if you leave field mask empty and do not provide a value for subscriber_email_addresses, then subscriber_email_addresses is updated to empty.

          Location: query

          Format: google-fieldmask

      Parameter Order: name

      Flat Path: v2beta/organizations/{organizationsId}/cases

      Description: Update the specified case. Only a subset of fields can be updated.

  • cloudsupport.projects.cases.list

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: GET

      Description: Retrieve all cases under the specified parent. Note: Listing cases under an Organization returns only the cases directly parented by that organization. To retrieve all cases under an organization, including cases parented by projects under that organization, use `cases.search`.

      Path: v2beta/{+parent}/cases

      Parameters:

        pageToken

          Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.

          Type: string

          Location: query

        pageSize

          Description: The maximum number of cases fetched with each request. Defaults to 10.

          Location: query

          Type: integer

          Format: int32

        filter

          Description: An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases. Filter expressions use the following fields with the operators equals (`=`) and `AND`: - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - [DEPRECATED] `severity`: The accepted values are `S0`, `S1`, `S2`, `S3`, or `S4`. - `creator.email`: The email address of the case creator. Examples: - `state=CLOSED` - `state=OPEN AND creator.email="tester@example.com"` - `state=OPEN AND (priority=P0 OR priority=P1)`

          Type: string

          Location: query

        parent

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+$

          Description: Required. The fully qualified name of parent resource to list cases under.

          Type: string

      Flat Path: v2beta/projects/{projectsId}/cases

  • cloudsupport.projects.cases.get

      Flat Path: v2beta/projects/{projectsId}/cases/{casesId}

      Parameters:

        name

          Required: Yes

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/cases/[^/]+$

          Description: Required. The fully qualified name of a case to be retrieved.

      HTTP Method: GET

      Description: Retrieve the specified case.

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v2beta/{+name}

  • cloudsupport.projects.cases.create

      Description: Create a new case and associate it with the given Cloud resource. The case object must have the following fields set: display_name, description, classification, and severity.

      Parameter Order: parent

      Flat Path: v2beta/projects/{projectsId}/cases

      HTTP Method: POST

      Path: v2beta/{+parent}/cases

      Parameters:

        parent

          Required: Yes

          Location: path

          Type: string

          Description: Required. The name of the Cloud resource under which the case should be created.

          Pattern: ^projects/[^/]+$

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • cloudsupport.projects.cases.close

      Path: v2beta/{+name}:close

      Flat Path: v2beta/projects/{projectsId}/cases/{casesId}:close

      HTTP Method: POST

      Parameters:

        name

          Location: path

          Required: Yes

          Description: Required. The fully qualified name of the case resource to be closed.

          Pattern: ^projects/[^/]+/cases/[^/]+$

          Type: string

      Description: Close the specified case.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

  • cloudsupport.projects.cases.escalate

      Description: Escalate a case. Escalating a case will initiate the Cloud Support escalation management process. This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.

      HTTP Method: POST

      Flat Path: v2beta/projects/{projectsId}/cases/{casesId}:escalate

      Parameters:

        name

          Pattern: ^projects/[^/]+/cases/[^/]+$

          Description: Required. The fully qualified name of the Case resource to be escalated.

          Location: path

          Required: Yes

          Type: string

      Path: v2beta/{+name}:escalate

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • cloudsupport.projects.cases.comments.list

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v2beta/{+parent}/comments

      Parameters:

        parent

          Location: path

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/cases/[^/]+$

          Description: Required. The resource name of Case object for which comments should be listed.

        pageSize

          Description: The maximum number of comments fetched with each request. Defaults to 10.

          Type: integer

          Location: query

          Format: int32

        pageToken

          Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.

          Location: query

          Type: string

      Flat Path: v2beta/projects/{projectsId}/cases/{casesId}/comments

      Description: Retrieve all Comments associated with the Case object.

      HTTP Method: GET

      Parameter Order: parent

  • cloudsupport.projects.cases.comments.create

      Description: Add a new comment to the specified Case. The comment object must have the following fields set: body.

      Parameters:

        parent

          Type: string

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/cases/[^/]+$

          Description: Required. The resource name of Case to which this comment should be added.

      Flat Path: v2beta/projects/{projectsId}/cases/{casesId}/comments

      Path: v2beta/{+parent}/comments

      Parameter Order: parent

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • cloudsupport.projects.cases.attachments.list

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v2beta/projects/{projectsId}/cases/{casesId}/attachments

      Path: v2beta/{+parent}/attachments

      HTTP Method: GET

      Parameters:

        pageToken

          Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.

          Location: query

          Type: string

        parent

          Type: string

          Description: Required. The resource name of Case object for which attachments should be listed.

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/cases/[^/]+$

        pageSize

          Format: int32

          Description: The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be returned is 100.

          Location: query

          Type: integer

      Description: Retrieve all attachments associated with a support case.

  • cloudsupport.projects.updateCases

      Path: v2beta/{+name}

      Flat Path: v2beta/projects/{projectsId}/cases

      Description: Update the specified case. Only a subset of fields can be updated.

      Parameters:

        updateMask

          Type: string

          Description: A list of attributes of the case object that should be updated as part of this request. Supported values are severity, display_name, and subscriber_email_addresses. If no fields are specified, all supported fields are updated. WARNING: If you do not provide a field mask, then you may accidentally clear some fields. For example, if you leave field mask empty and do not provide a value for subscriber_email_addresses, then subscriber_email_addresses is updated to empty.

          Location: query

          Format: google-fieldmask

        name

          Location: path

          Pattern: ^projects/[^/]+/cases$

          Required: Yes

          Type: string

          Description: The resource name for the case.

      HTTP Method: PATCH

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

Updates

    Methods
  • cloudsupport.media.upload

      Parameters:

        parent

          Pattern: ^[^/]+/[^/]+/cases/[^/]+$  ⟶  ^organizations/[^/]+/cases/[^/]+$

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments  ⟶  v2beta/organizations/{organizationsId}/cases/{casesId}/attachments

  • cloudsupport.media.download

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments/{attachmentsId}:download  ⟶  v2beta/organizations/{organizationsId}/cases/{casesId}/attachments/{attachmentsId}:download

      Parameters:

        name

          Pattern: ^[^/]+/[^/]+/cases/[^/]+/attachments/[^/]+$  ⟶  ^organizations/[^/]+/cases/[^/]+/attachments/[^/]+$

Deletions

    Methods
  • cloudsupport.attachments.create

      Description: Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename.

      HTTP Method: POST

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/attachments

      Parameters:

        parent

          Type: string

          Pattern: ^[^/]+/[^/]+$

          Required: Yes

          Description: Required. The resource name of the case (or case parent) to which the attachment should be attached.

          Location: path

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v2beta/{+parent}/attachments

      Parameter Order: parent

  • cloudsupport.cases.list

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases

      Parameters:

        pageSize

          Description: The maximum number of cases fetched with each request. Defaults to 10.

          Type: integer

          Format: int32

          Location: query

        parent

          Location: path

          Pattern: ^[^/]+/[^/]+$

          Type: string

          Required: Yes

          Description: Required. The fully qualified name of parent resource to list cases under.

        filter

          Type: string

          Location: query

          Description: An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases. Filter expressions use the following fields with the operators equals (`=`) and `AND`: - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - [DEPRECATED] `severity`: The accepted values are `S0`, `S1`, `S2`, `S3`, or `S4`. - `creator.email`: The email address of the case creator. Examples: - `state=CLOSED` - `state=OPEN AND creator.email="tester@example.com"` - `state=OPEN AND (priority=P0 OR priority=P1)`

        pageToken

          Location: query

          Type: string

          Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: GET

      Description: Retrieve all cases under the specified parent. Note: Listing cases under an Organization returns only the cases directly parented by that organization. To retrieve all cases under an organization, including cases parented by projects under that organization, use `cases.search`.

      Parameter Order: parent

      Path: v2beta/{+parent}/cases

  • cloudsupport.cases.patch

      Path: v2beta/{+name}

      HTTP Method: PATCH

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Description: Update the specified case. Only a subset of fields can be updated.

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}

      Parameters:

        name

          Description: The resource name for the case.

          Required: Yes

          Location: path

          Pattern: ^[^/]+/[^/]+/cases/[^/]+$

          Type: string

        updateMask

          Type: string

          Description: A list of attributes of the case object that should be updated as part of this request. Supported values are severity, display_name, and subscriber_email_addresses. If no fields are specified, all supported fields are updated. WARNING: If you do not provide a field mask, then you may accidentally clear some fields. For example, if you leave field mask empty and do not provide a value for subscriber_email_addresses, then subscriber_email_addresses is updated to empty.

          Format: google-fieldmask

          Location: query

  • cloudsupport.cases.escalate

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Type: string

          Description: Required. The fully qualified name of the Case resource to be escalated.

          Pattern: ^[^/]+/[^/]+/cases/[^/]+$

          Location: path

          Required: Yes

      Parameter Order: name

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}:escalate

      HTTP Method: POST

      Path: v2beta/{+name}:escalate

      Description: Escalate a case. Escalating a case will initiate the Cloud Support escalation management process. This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.

  • cloudsupport.cases.get

      Description: Retrieve the specified case.

      Parameters:

        name

          Description: Required. The fully qualified name of a case to be retrieved.

          Type: string

          Location: path

          Required: Yes

          Pattern: ^[^/]+/[^/]+/cases/[^/]+$

      Path: v2beta/{+name}

      Parameter Order: name

      HTTP Method: GET

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • cloudsupport.cases.create

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases

      Path: v2beta/{+parent}/cases

      Parameters:

        parent

          Location: path

          Description: Required. The name of the Cloud resource under which the case should be created.

          Required: Yes

          Type: string

          Pattern: ^[^/]+/[^/]+$

      Description: Create a new case and associate it with the given Cloud resource. The case object must have the following fields set: display_name, description, classification, and severity.

      HTTP Method: POST

  • cloudsupport.cases.close

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}:close

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      HTTP Method: POST

      Description: Close the specified case.

      Parameters:

        name

          Type: string

          Description: Required. The fully qualified name of the case resource to be closed.

          Pattern: ^[^/]+/[^/]+/cases/[^/]+$

          Required: Yes

          Location: path

      Path: v2beta/{+name}:close

  • cloudsupport.cases.attachments.list

      Parameters:

        pageSize

          Type: integer

          Description: The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be returned is 100.

          Format: int32

          Location: query

        parent

          Pattern: ^[^/]+/[^/]+/cases/[^/]+$

          Description: Required. The resource name of Case object for which attachments should be listed.

          Location: path

          Required: Yes

          Type: string

        pageToken

          Location: query

          Type: string

          Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.

      Description: Retrieve all attachments associated with a support case.

      Parameter Order: parent

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v2beta/{+parent}/attachments

  • cloudsupport.cases.comments.create

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/comments

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

      Description: Add a new comment to the specified Case. The comment object must have the following fields set: body.

      Path: v2beta/{+parent}/comments

      Parameters:

        parent

          Description: Required. The resource name of Case to which this comment should be added.

          Location: path

          Type: string

          Pattern: ^[^/]+/[^/]+/cases/[^/]+$

          Required: Yes

  • cloudsupport.cases.comments.list

      HTTP Method: GET

      Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/comments

      Parameter Order: parent

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.

        parent

          Description: Required. The resource name of Case object for which comments should be listed.

          Required: Yes

          Pattern: ^[^/]+/[^/]+/cases/[^/]+$

          Type: string

          Location: path

        pageSize

          Description: The maximum number of comments fetched with each request. Defaults to 10.

          Location: query

          Type: integer

          Format: int32

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Retrieve all Comments associated with the Case object.

      Path: v2beta/{+parent}/comments