OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-06 11:34:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

update all APIs

Browse Source 
Like documented in the README

```
rm -f .api.deps .cli.deps && FETCH_APIS=1 make update-json -j8
```
This commit is contained in:
Sebastian Thiel
2024-03-05 18:54:36 +01:00
parent 8a12e9d47e
commit ca974aa0a5
347 changed files with 202580 additions and 50157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

222
etc/api/cloudsupport/v2beta/cloudsupport-api.json
View File

@@ -105,49 +105,17 @@
},
"protocol": "rest",
"resources": {
"attachments": {
"methods": {
"create": {
"description": "Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename.",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/attachments",
"httpMethod": "POST",
"id": "cloudsupport.attachments.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the case (or case parent) to which the attachment should be attached.",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta/{+parent}/attachments",
"request": {
"$ref": "CreateAttachmentRequest"
},
"response": {
"$ref": "Attachment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"caseClassifications": {
"methods": {
"search": {
"description": "Retrieve valid classifications to be used when creating a support case. The classications are hierarchical, with each classification containing all levels of the hierarchy, separated by \" > \". For example \"Technical Issue > Compute > Compute Engine\".",
"description": "Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `\" > \"`. For example, `\"Technical Issue > Compute > Compute Engine\"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:\"*Compute%20Engine*\"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=\"v2\", discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version=v2\", ) request = supportApiService.caseClassifications().search( query='display_name:\"*Compute Engine*\"' ) print(request.execute()) ```",
"flatPath": "v2beta/caseClassifications:search",
"httpMethod": "GET",
"id": "cloudsupport.caseClassifications.search",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "The maximum number of cases fetched with each request.",
"description": "The maximum number of classifications fetched with each request.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -157,8 +125,28 @@
"location": "query",
"type": "string"
},
"product.productLine": {
"description": "The Product Line of the Product.",
"enum": [
"PRODUCT_LINE_UNSPECIFIED",
"GOOGLE_CLOUD",
"GOOGLE_MAPS"
],
"enumDescriptions": [
"Unknown product type.",
"Google Cloud",
"Google Maps"
],
"location": "query",
"type": "string"
},
"product.productSubline": {
"description": "The Product Subline of the Product, such as \"Maps Billing\".",
"location": "query",
"type": "string"
},
"query": {
"description": "An expression written in the Cloud filter language. If non-empty, then only cases whose fields match the filter are returned. If empty, then no messages are filtered out.",
"description": "An expression used to filter case classifications. If it's an empty string, then no filtering happens. Otherwise, case classifications will be returned that match the filter.",
"location": "query",
"type": "string"
}
@@ -176,7 +164,7 @@
"cases": {
"methods": {
"close": {
"description": "Close the specified case.",
"description": "Close a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case:close\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().close( name=\"projects/some-project/cases/43595344\" ) print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}:close",
"httpMethod": "POST",
"id": "cloudsupport.cases.close",
@@ -185,7 +173,7 @@
],
"parameters": {
"name": {
"description": "Required. The fully qualified name of the case resource to be closed.",
"description": "Required. The name of the case to close.",
"location": "path",
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
"required": true,
@@ -204,7 +192,7 @@
]
},
"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.",
"description": "Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"display_name\": \"Test case created by me.\", \"description\": \"a random test case, feel free to close\", \"classification\": { \"id\": \"100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8\" }, \"time_zone\": \"-07:00\", \"subscriber_email_addresses\": [ \"foo@domain.com\", \"bar@domain.com\" ], \"testCase\": true, \"priority\": \"P3\" }' \\ \"https://cloudsupport.googleapis.com/v2/$parent/cases\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().create( parent=\"projects/some-project\", body={ \"displayName\": \"A Test Case\", \"description\": \"This is a test case.\", \"testCase\": True, \"priority\": \"P2\", \"classification\": { \"id\": \"100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8\" }, }, ) print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases",
"httpMethod": "POST",
"id": "cloudsupport.cases.create",
@@ -213,7 +201,7 @@
],
"parameters": {
"parent": {
"description": "Required. The name of the Cloud resource under which the case should be created.",
"description": "Required. The name of the parent under which the case should be created.",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
@@ -232,7 +220,7 @@
]
},
"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.",
"description": "Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"escalation\": { \"reason\": \"BUSINESS_IMPACT\", \"justification\": \"This is a test escalation.\" } }' \\ \"https://cloudsupport.googleapis.com/v2/$case:escalate\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().escalate( name=\"projects/some-project/cases/43595344\", body={ \"escalation\": { \"reason\": \"BUSINESS_IMPACT\", \"justification\": \"This is a test escalation.\", }, }, ) print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}:escalate",
"httpMethod": "POST",
"id": "cloudsupport.cases.escalate",
@@ -241,7 +229,7 @@
],
"parameters": {
"name": {
"description": "Required. The fully qualified name of the Case resource to be escalated.",
"description": "Required. The name of the case to be escalated.",
"location": "path",
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
"required": true,
@@ -260,7 +248,7 @@
]
},
"get": {
"description": "Retrieve the specified case.",
"description": "Retrieve a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/16033687\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().get( name=\"projects/some-project/cases/43595344\", ) print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}",
"httpMethod": "GET",
"id": "cloudsupport.cases.get",
@@ -269,7 +257,7 @@
],
"parameters": {
"name": {
"description": "Required. The fully qualified name of a case to be retrieved.",
"description": "Required. The full name of a case to be retrieved.",
"location": "path",
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
"required": true,
@@ -285,7 +273,7 @@
]
},
"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`.",
"description": "Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$parent/cases\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().list(parent=\"projects/some-project\") print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases",
"httpMethod": "GET",
"id": "cloudsupport.cases.list",
@@ -294,7 +282,7 @@
],
"parameters": {
"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)`",
"description": "An expression used to filter cases. If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter. Expressions use the following fields separated by `AND` and specified with `=`: - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `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)`",
"location": "query",
"type": "string"
},
@@ -310,11 +298,26 @@
"type": "string"
},
"parent": {
"description": "Required. The fully qualified name of parent resource to list cases under.",
"description": "Required. The name of a parent to list cases under.",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
"type": "string"
},
"productLine": {
"description": "The product line for which to request cases for. If unspecified, only Google Cloud cases will be returned.",
"enum": [
"PRODUCT_LINE_UNSPECIFIED",
"GOOGLE_CLOUD",
"GOOGLE_MAPS"
],
"enumDescriptions": [
"Unknown product type.",
"Google Cloud",
"Google Maps"
],
"location": "query",
"type": "string"
}
},
"path": "v2beta/{+parent}/cases",
@@ -326,7 +329,7 @@
]
},
"patch": {
"description": "Update the specified case. Only a subset of fields can be updated.",
"description": "Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request PATCH \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"priority\": \"P1\" }' \\ \"https://cloudsupport.googleapis.com/v2/$case?updateMask=priority\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().patch( name=\"projects/some-project/cases/43112854\", body={ \"displayName\": \"This is Now a New Title\", \"priority\": \"P2\", }, ) print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}",
"httpMethod": "PATCH",
"id": "cloudsupport.cases.patch",
@@ -342,7 +345,7 @@
"type": "string"
},
"updateMask": {
"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.",
"description": "A list of attributes of the case that should be updated. Supported values are `priority`, `display_name`, and `subscriber_email_addresses`. If no fields are specified, all supported fields are updated. Be careful - if you do not provide a field mask, then you might accidentally clear some fields. For example, if you leave the 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",
"type": "string"
@@ -360,7 +363,7 @@
]
},
"search": {
"description": "Search cases using the specified query.",
"description": "Search for cases using a query. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$parent/cases:search\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().search( parent=\"projects/some-project\", query=\"state=OPEN\" ) print(request.execute()) ```",
"flatPath": "v2beta/cases:search",
"httpMethod": "GET",
"id": "cloudsupport.cases.search",
@@ -377,8 +380,13 @@
"location": "query",
"type": "string"
},
"parent": {
"description": "The name of the parent resource to search for cases under.",
"location": "query",
"type": "string"
},
"query": {
"description": "An expression written in filter language. A query uses the following fields with the operators equals (`=`) and `AND`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `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. - `billingAccount`: A billing account in the form `billingAccounts/` You must specify eitehr `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `\"my search\"`. To search only cases updated after a certain date, use `update_time` retricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `billing_account=\"billingAccounts/123456-A0B0C0-CUZ789\"` - `organization=\"organizations/123456789\" AND state=CLOSED` - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"` - `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)`",
"description": "An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. You must specify either `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `\"my search\"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `organization=\"organizations/123456789\" AND state=CLOSED` - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"` - `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)`",
"location": "query",
"type": "string"
}
@@ -396,7 +404,7 @@
"attachments": {
"methods": {
"list": {
"description": "Retrieve all attachments associated with a support case.",
"description": "List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/23598314\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case/attachments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .attachments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments",
"httpMethod": "GET",
"id": "cloudsupport.cases.attachments.list",
@@ -416,7 +424,7 @@
"type": "string"
},
"parent": {
"description": "Required. The resource name of Case object for which attachments should be listed.",
"description": "Required. The name of the case for which attachments should be listed.",
"location": "path",
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
"required": true,
@@ -436,7 +444,7 @@
"comments": {
"methods": {
"create": {
"description": "Add a new comment to the specified Case. The comment object must have the following fields set: body.",
"description": "Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43591344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"body\": \"This is a test comment.\" }' \\ \"https://cloudsupport.googleapis.com/v2/$case/comments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .comments() .create( parent=\"projects/some-project/cases/43595344\", body={\"body\": \"This is a test comment.\"}, ) ) print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/comments",
"httpMethod": "POST",
"id": "cloudsupport.cases.comments.create",
@@ -445,7 +453,7 @@
],
"parameters": {
"parent": {
"description": "Required. The resource name of Case to which this comment should be added.",
"description": "Required. The name of the case to which the comment should be added.",
"location": "path",
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
"required": true,
@@ -464,7 +472,7 @@
]
},
"list": {
"description": "Retrieve all Comments associated with the Case object.",
"description": "List all the comments associated with a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case/comments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .comments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/comments",
"httpMethod": "GET",
"id": "cloudsupport.cases.comments.list",
@@ -473,18 +481,18 @@
],
"parameters": {
"pageSize": {
"description": "The maximum number of comments fetched with each request. Defaults to 10.",
"description": "The maximum number of comments to fetch. Defaults to 10.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.",
"description": "A token identifying the page of results to return. If unspecified, the first page is returned.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of Case object for which comments should be listed.",
"description": "Required. The name of the case for which to list comments.",
"location": "path",
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
"required": true,
@@ -506,7 +514,7 @@
"media": {
"methods": {
"download": {
"description": "Download a file attachment on a case. Note: HTTP requests must append \"?alt=media\" to the URL.",
"description": "Download a file attached to a case. Note: HTTP requests must append \"?alt=media\" to the URL. EXAMPLES: cURL: ```shell name=\"projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$name:download?alt=media\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.media().download( name=\"projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR\" ) request.uri = request.uri.split(\"?\")[0] + \"?alt=media\" print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments/{attachmentsId}:download",
"httpMethod": "GET",
"id": "cloudsupport.media.download",
@@ -515,7 +523,7 @@
],
"parameters": {
"name": {
"description": "The resource name of the attachment to be downloaded.",
"description": "The name of the file attachment to download.",
"location": "path",
"pattern": "^[^/]+/[^/]+/cases/[^/]+/attachments/[^/]+$",
"required": true,
@@ -533,7 +541,7 @@
"useMediaDownloadService": true
},
"upload": {
"description": "Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename.",
"description": "Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo \"This text is in a file I'm uploading using CSAPI.\" \\ > \"./example_file.txt\" case=\"projects/some-project/cases/43594844\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --data-binary @\"./example_file.txt\" \\ \"https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) file_path = \"./example_file.txt\" with open(file_path, \"w\") as file: file.write( \"This text is inside a file I'm going to upload using the Cloud Support API.\", ) request = supportApiService.media().upload( parent=\"projects/some-project/cases/43595344\", media_body=file_path ) request.uri = request.uri.split(\"?\")[0] + \"?attachment.filename=uploaded_via_python.txt\" print(request.execute()) ```",
"flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments",
"httpMethod": "POST",
"id": "cloudsupport.media.upload",
@@ -553,7 +561,7 @@
],
"parameters": {
"parent": {
"description": "Required. The resource name of the case (or case parent) to which the attachment should be attached.",
"description": "Required. The name of the case or Cloud resource to which the attachment should be attached.",
"location": "path",
"pattern": "^[^/]+/[^/]+/cases/[^/]+$",
"required": true,
@@ -575,11 +583,11 @@
}
}
},
"revision": "20230121",
"revision": "20240304",
"rootUrl": "https://cloudsupport.googleapis.com/",
"schemas": {
"Actor": {
"description": "An object containing information about the effective user and authenticated principal responsible for an action.",
"description": "An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case.",
"id": "Actor",
"properties": {
"displayName": {
@@ -587,19 +595,25 @@
"type": "string"
},
"email": {
"description": "The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.",
"deprecated": true,
"description": "The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead.",
"type": "string"
},
"googleSupport": {
"description": "Output only. Whether the actor is a Google support actor.",
"readOnly": true,
"type": "boolean"
},
"username": {
"description": "Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Attachment": {
"description": "Represents a file attached to a support case.",
"description": "An Attachment contains metadata about a file that was uploaded to a case - it is NOT a file itself. That being said, the name of an Attachment object can be used to download its accompanying file through the `media.download` endpoint. While attachments can be uploaded in the console at the same time as a comment, they're associated on a \"case\" level, not a \"comment\" level.",
"id": "Attachment",
"properties": {
"createTime": {
@@ -667,13 +681,17 @@
"type": "object"
},
"Case": {
"description": "A support case.",
"description": "A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time. A case is parented by a Google Cloud organization or project. Organizations are identified by a number, so the name of a case parented by an organization would look like this: ``` organizations/123/cases/456 ``` Projects have two unique identifiers, an ID and a number, and they look like this: ``` projects/abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them when calling the API. To learn more about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).",
"id": "Case",
"properties": {
"classification": {
"$ref": "CaseClassification",
"description": "The issue classification applicable to this case."
},
"contactEmail": {
"description": "A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs.",
"type": "string"
},
"createTime": {
"description": "Output only. The time this case was created.",
"format": "google-datetime",
@@ -705,7 +723,7 @@
"type": "string"
},
"priority": {
"description": "The priority of this case. If this is set, do not set severity.",
"description": "The priority of this case.",
"enum": [
"PRIORITY_UNSPECIFIED",
"P0",
@@ -725,7 +743,7 @@
"type": "string"
},
"severity": {
"description": "The severity of this case. Deprecated. Use priority instead.",
"description": "REMOVED. The severity of this case. Use priority instead.",
"enum": [
"SEVERITY_UNSPECIFIED",
"S0",
@@ -790,16 +808,20 @@
"type": "object"
},
"CaseClassification": {
"description": "A classification object with a product type and value.",
"description": "A Case Classification represents the topic that a case is about. It's very important to use accurate classifications, because they're used to route your cases to specialists who can help you. A classification always has an ID that is its unique identifier. A valid ID is required when creating a case.",
"id": "CaseClassification",
"properties": {
"displayName": {
"description": "The display name of the classification.",
"description": "A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.",
"type": "string"
},
"id": {
"description": "The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`.",
"description": "The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.",
"type": "string"
},
"product": {
"$ref": "Product",
"description": "The full product the classification corresponds to."
}
},
"type": "object"
@@ -811,11 +833,11 @@
"type": "object"
},
"Comment": {
"description": "A comment associated with a support case.",
"description": "Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments.",
"id": "Comment",
"properties": {
"body": {
"description": "The full comment body. Maximum of 120000 characters. This can contain rich text syntax.",
"description": "The full comment body. Maximum of 12800 characters. This can contain rich text syntax.",
"type": "string"
},
"createTime": {
@@ -835,7 +857,7 @@
"type": "string"
},
"plainTextBody": {
"description": "Output only. An automatically generated plain text version of body with all rich text syntax stripped.",
"description": "Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped.",
"readOnly": true,
"type": "string"
}
@@ -847,6 +869,7 @@
"id": "CompositeMedia",
"properties": {
"blobRef": {
"deprecated": true,
"description": "# gdata.* are outside protos with mising documentation",
"format": "byte",
"type": "string"
@@ -1063,7 +1086,7 @@
"properties": {
"escalation": {
"$ref": "Escalation",
"description": "The escalation object to be sent with the escalation request."
"description": "The escalation information to be sent with the escalation request."
}
},
"type": "object"
@@ -1100,14 +1123,14 @@
"id": "ListAttachmentsResponse",
"properties": {
"attachments": {
"description": "The list of attachments associated with the given case.",
"description": "The list of attachments associated with a case.",
"items": {
"$ref": "Attachment"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `cases.attachments.list` requests. If unspecified, there are no more results to retrieve.",
"description": "A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.attachments.list` requests. If unspecified, there are no more results to retrieve.",
"type": "string"
}
},
@@ -1118,14 +1141,14 @@
"id": "ListCasesResponse",
"properties": {
"cases": {
"description": "The list of cases associated with the cloud resource, after any filters have been applied.",
"description": "The list of cases associated with the parent after any filters have been applied.",
"items": {
"$ref": "Case"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `ListCasesRequest` message that is issued. If unspecified, there are no more results to retrieve.",
"description": "A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.list` requests. If unspecified, there are no more results to retrieve.",
"type": "string"
}
},
@@ -1136,14 +1159,14 @@
"id": "ListCommentsResponse",
"properties": {
"comments": {
"description": "The list of Comments associated with the given Case.",
"description": "List of the comments associated with the case.",
"items": {
"$ref": "Comment"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `ListCommentsRequest` message that is issued. If unspecified, there are no more results to retrieve.",
"description": "A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.comments.list` requests. If unspecified, there are no more results to retrieve.",
"type": "string"
}
},
@@ -1154,15 +1177,18 @@
"id": "Media",
"properties": {
"algorithm": {
"deprecated": true,
"description": "# gdata.* are outside protos with mising documentation",
"type": "string"
},
"bigstoreObjectRef": {
"deprecated": true,
"description": "# gdata.* are outside protos with mising documentation",
"format": "byte",
"type": "string"
},
"blobRef": {
"deprecated": true,
"description": "# gdata.* are outside protos with mising documentation",
"format": "byte",
"type": "string"
@@ -1225,6 +1251,7 @@
"type": "string"
},
"hash": {
"deprecated": true,
"description": "# gdata.* are outside protos with mising documentation",
"type": "string"
},
@@ -1340,6 +1367,31 @@
},
"type": "object"
},
"Product": {
"description": "The full product a case may be associated with, including Product Line and Product Subline.",
"id": "Product",
"properties": {
"productLine": {
"description": "The Product Line of the Product.",
"enum": [
"PRODUCT_LINE_UNSPECIFIED",
"GOOGLE_CLOUD",
"GOOGLE_MAPS"
],
"enumDescriptions": [
"Unknown product type.",
"Google Cloud",
"Google Maps"
],
"type": "string"
},
"productSubline": {
"description": "The Product Subline of the Product, such as \"Maps Billing\".",
"type": "string"
}
},
"type": "object"
},
"SearchCaseClassificationsResponse": {
"description": "The response message for SearchCaseClassifications endpoint.",
"id": "SearchCaseClassificationsResponse",
@@ -1352,7 +1404,7 @@
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `SearchCaseClassificationsRequest` message that is issued. If unspecified, there are no more results to retrieve.",
"description": "A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `caseClassifications.list` requests. If unspecified, there are no more results to retrieve.",
"type": "string"
}
},
@@ -1363,14 +1415,14 @@
"id": "SearchCasesResponse",
"properties": {
"cases": {
"description": "The list of Case associated with the cloud resource, after any filters have been applied.",
"description": "The list of cases associated with the parent after any filters have been applied.",
"items": {
"$ref": "Case"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `SearchCaseRequest` message that is issued. If unspecified, there are no more results to retrieve.",
"description": "A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.search` requests. If unspecified, there are no more results to retrieve.",
"type": "string"
}
},