2023-03-31
▼ ▲ cloudsupport.cases.comments.create
Path: v2beta/{+parent}/comments
Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/comments
Description: Add a new comment to the specified Case. The comment object must have the following fields set: body.
Parameters:
parent
Description: Required. The resource name of Case to which this comment should be added.
Type: string
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Required: Yes
Location: path
HTTP Method: POST
Parameter Order: parent
▼ ▲ cloudsupport.cases.comments.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
parent
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Location: path
Description: Required. The resource name of Case object for which comments should be listed.
Type: string
Required: Yes
pageToken
Type: string
Location: query
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
pageSize
Type: integer
Location: query
Description: The maximum number of comments fetched with each request. Defaults to 10.
Format: int32
Parameter Order: parent
Path: v2beta/{+parent}/comments
Description: Retrieve all Comments associated with the Case object.
Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/comments
▼ ▲ cloudsupport.cases.attachments.list
Parameters:
pageSize
Format: int32
Type: integer
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.
parent
Location: path
Description: Required. The resource name of Case object for which attachments should be listed.
Type: string
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Required: Yes
pageToken
Location: query
Type: string
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments
Description: Retrieve all attachments associated with a support case.
Path: v2beta/{+parent}/attachments
Parameter Order: parent
▼ ▲ cloudsupport.cases.create
Parameters:
parent
Description: Required. The name of the Cloud resource under which the case should be created.
Pattern: ^[^/]+/[^/]+$
Location: path
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.
HTTP Method: POST
Path: v2beta/{+parent}/cases
Parameter Order: parent
Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases
▼ ▲ cloudsupport.cases.patch
Parameters:
updateMask
Type: string
Location: query
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
name
Required: Yes
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Description: The resource name for the case.
Location: path
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Update the specified case. Only a subset of fields can be updated.
Path: v2beta/{+name}
Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}
HTTP Method: PATCH
▼ ▲ cloudsupport.cases.escalate
Parameters:
name
Description: Required. The fully qualified name of the Case resource to be escalated.
Type: string
Location: path
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Required: Yes
Path: v2beta/{+name}:escalate
Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}: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.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ cloudsupport.cases.get
Path: v2beta/{+name}
Parameters:
name
Required: Yes
Type: string
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Description: Required. The fully qualified name of a case to be retrieved.
Location: path
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Retrieve the specified case.
Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}
HTTP Method: GET
▼ ▲ cloudsupport.cases.list
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
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
pageSize
Type: integer
Description: The maximum number of cases fetched with each request. Defaults to 10.
Location: query
Format: int32
parent
Required: Yes
Location: path
Pattern: ^[^/]+/[^/]+$
Description: Required. The fully qualified name of parent resource to list cases under.
Type: string
pageToken
Location: query
Type: string
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
filter
Location: query
Type: string
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)`
Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases
▼ ▲ cloudsupport.cases.close
Parameters:
name
Type: string
Description: Required. The fully qualified name of the case resource to be closed.
Pattern: ^[^/]+/[^/]+/cases/[^/]+$
Required: Yes
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}:close
Parameter Order: name
Path: v2beta/{+name}:close
Description: Close the specified case.
▼ ▲ cloudsupport.media.upload
Parameters:
parent
Pattern: ^organizations/[^/]+/cases/[^/]+$ ⟶ ^[^/]+/[^/]+/cases/[^/]+$
Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}/attachments ⟶ v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments
▼ ▲ cloudsupport.media.download
Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}/attachments/{attachmentsId}:download ⟶ v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments/{attachmentsId}:download
Parameters:
name
Pattern: ^organizations/[^/]+/cases/[^/]+/attachments/[^/]+$ ⟶ ^[^/]+/[^/]+/cases/[^/]+/attachments/[^/]+$
▼ ▲ cloudsupport.projects.updateCases
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2beta/projects/{projectsId}/cases
Parameters:
name
Pattern: ^projects/[^/]+/cases$
Required: Yes
Description: The resource name for the case.
Type: string
Location: path
updateMask
Location: query
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
Type: string
Description: Update the specified case. Only a subset of fields can be updated.
HTTP Method: PATCH
Parameter Order: name
Path: v2beta/{+name}
▼ ▲ cloudsupport.projects.cases.attachments.list
Parameter Order: parent
Path: v2beta/{+parent}/attachments
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
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
Location: query
Type: string
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
parent
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/cases/[^/]+$
Description: Required. The resource name of Case object for which attachments should be listed.
Flat Path: v2beta/projects/{projectsId}/cases/{casesId}/attachments
HTTP Method: GET
Description: Retrieve all attachments associated with a support case.
▼ ▲ cloudsupport.projects.cases.comments.list
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2beta/{+parent}/comments
Parameters:
parent
Pattern: ^projects/[^/]+/cases/[^/]+$
Required: Yes
Description: Required. The resource name of Case object for which comments should be listed.
Location: path
Type: string
pageSize
Type: integer
Format: int32
Description: The maximum number of comments fetched with each request. Defaults to 10.
Location: query
pageToken
Type: string
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
Location: query
Description: Retrieve all Comments associated with the Case object.
Flat Path: v2beta/projects/{projectsId}/cases/{casesId}/comments
HTTP Method: GET
▼ ▲ cloudsupport.projects.cases.comments.create
HTTP Method: POST
Parameter Order: parent
Path: v2beta/{+parent}/comments
Description: Add a new comment to the specified Case. The comment object must have the following fields set: body.
Flat Path: v2beta/projects/{projectsId}/cases/{casesId}/comments
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Type: string
Required: Yes
Description: Required. The resource name of Case to which this comment should be added.
Pattern: ^projects/[^/]+/cases/[^/]+$
Location: path
▼ ▲ cloudsupport.projects.cases.list
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+$
Location: path
Description: Required. The fully qualified name of parent resource to list cases under.
Required: Yes
pageSize
Type: integer
Format: int32
Location: query
Description: The maximum number of cases fetched with each request. Defaults to 10.
pageToken
Type: string
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
Location: query
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)`
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`.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v2beta/{+parent}/cases
Flat Path: v2beta/projects/{projectsId}/cases
▼ ▲ cloudsupport.projects.cases.create
Path: v2beta/{+parent}/cases
Parameter Order: parent
Parameters:
parent
Location: path
Pattern: ^projects/[^/]+$
Description: Required. The name of the Cloud resource under which the case should be created.
Type: string
Required: Yes
Flat Path: v2beta/projects/{projectsId}/cases
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ cloudsupport.projects.cases.escalate
Flat Path: v2beta/projects/{projectsId}/cases/{casesId}: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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v2beta/{+name}:escalate
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/cases/[^/]+$
Description: Required. The fully qualified name of the Case resource to be escalated.
HTTP Method: POST
▼ ▲ cloudsupport.projects.cases.get
Description: Retrieve the specified case.
Flat Path: v2beta/projects/{projectsId}/cases/{casesId}
Parameters:
name
Description: Required. The fully qualified name of a case to be retrieved.
Pattern: ^projects/[^/]+/cases/[^/]+$
Location: path
Type: string
Required: Yes
HTTP Method: GET
Path: v2beta/{+name}
Parameter Order: name
▼ ▲ cloudsupport.projects.cases.close
Path: v2beta/{+name}:close
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. The fully qualified name of the case resource to be closed.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/cases/[^/]+$
HTTP Method: POST
Description: Close the specified case.
Flat Path: v2beta/projects/{projectsId}/cases/{casesId}:close
▼ ▲ cloudsupport.organizations.cases.close
Parameters:
name
Description: Required. The fully qualified name of the case resource to be closed.
Required: Yes
Type: string
Location: path
Pattern: ^organizations/[^/]+/cases/[^/]+$
Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}:close
Description: Close the specified case.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2beta/{+name}:close
HTTP Method: POST
Parameter Order: name
▼ ▲ cloudsupport.organizations.cases.list
Path: v2beta/{+parent}/cases
Parameters:
parent
Location: path
Required: Yes
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)`
pageToken
Location: query
Type: string
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
pageSize
Location: query
Format: int32
Type: integer
Description: The maximum number of cases fetched with each request. Defaults to 10.
Parameter Order: parent
Flat Path: v2beta/organizations/{organizationsId}/cases
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`.
▼ ▲ cloudsupport.organizations.cases.escalate
Parameters:
name
Type: string
Description: Required. The fully qualified name of the Case resource to be escalated.
Required: Yes
Location: path
Pattern: ^organizations/[^/]+/cases/[^/]+$
HTTP Method: POST
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2beta/{+name}:escalate
Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}: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.organizations.cases.create
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2beta/{+parent}/cases
Parameters:
parent
Type: string
Description: Required. The name of the Cloud resource under which the case should be created.
Location: path
Pattern: ^organizations/[^/]+$
Required: Yes
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
▼ ▲ cloudsupport.organizations.cases.get
Parameter Order: name
Path: v2beta/{+name}
Parameters:
name
Type: string
Pattern: ^organizations/[^/]+/cases/[^/]+$
Description: Required. The fully qualified name of a case to be retrieved.
Required: Yes
Location: path
HTTP Method: GET
Description: Retrieve the specified case.
Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}
▼ ▲ cloudsupport.organizations.cases.attachments.list
Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}/attachments
Parameters:
parent
Pattern: ^organizations/[^/]+/cases/[^/]+$
Location: path
Description: Required. The resource name of Case object for which attachments should be listed.
Required: Yes
Type: string
pageToken
Type: string
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
Location: query
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
Path: v2beta/{+parent}/attachments
Description: Retrieve all attachments associated with a support case.
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ cloudsupport.organizations.cases.comments.create
Path: v2beta/{+parent}/comments
Parameter Order: parent
Description: Add a new comment to the specified Case. The comment object must have the following fields set: body.
Parameters:
parent
Type: string
Required: Yes
Pattern: ^organizations/[^/]+/cases/[^/]+$
Description: Required. The resource name of Case to which this comment should be added.
Location: path
HTTP Method: POST
Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}/comments
▼ ▲ cloudsupport.organizations.cases.comments.list
Parameter Order: parent
Flat Path: v2beta/organizations/{organizationsId}/cases/{casesId}/comments
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2beta/{+parent}/comments
HTTP Method: GET
Description: Retrieve all Comments associated with the Case object.
Parameters:
pageToken
Type: string
Description: A token identifying the page of results to return. If unspecified, the first page is retrieved.
Location: query
parent
Description: Required. The resource name of Case object for which comments should be listed.
Location: path
Required: Yes
Pattern: ^organizations/[^/]+/cases/[^/]+$
Type: string
pageSize
Type: integer
Location: query
Description: The maximum number of comments fetched with each request. Defaults to 10.
Format: int32
▼ ▲ cloudsupport.organizations.updateCases
HTTP Method: PATCH
Flat Path: v2beta/organizations/{organizationsId}/cases
Description: Update the specified case. Only a subset of fields can be updated.
Path: v2beta/{+name}
Parameters:
name
Description: The resource name for the case.
Pattern: ^organizations/[^/]+/cases$
Type: string
Required: Yes
Location: path
updateMask
Format: google-fieldmask
Type: string
Location: query
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.
Parameter Order: name