- 0.48.0 (latest)
- 0.47.0
- 0.46.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static interface CaseServiceGrpc.AsyncService
A service to manage Google Cloud support cases.
Methods
closeCase(CloseCaseRequest request, StreamObserver<Case> responseObserver)
public default void closeCase(CloseCaseRequest request, StreamObserver<Case> responseObserver)
Close a case.
EXAMPLES:
cURL:
<code><code>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"
</code></code><code>
Python:
</code><code><code>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())
</code></code>
Parameters | |
---|---|
Name | Description |
request |
CloseCaseRequest |
responseObserver |
io.grpc.stub.StreamObserver<Case> |
createCase(CreateCaseRequest request, StreamObserver<Case> responseObserver)
public default void createCase(CreateCaseRequest request, StreamObserver<Case> responseObserver)
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:
<code><code>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"
</code></code><code>
Python:
</code><code><code>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())
</code></code>
Parameters | |
---|---|
Name | Description |
request |
CreateCaseRequest |
responseObserver |
io.grpc.stub.StreamObserver<Case> |
escalateCase(EscalateCaseRequest request, StreamObserver<Case> responseObserver)
public default void escalateCase(EscalateCaseRequest request, StreamObserver<Case> responseObserver)
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:
<code><code>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"
</code></code><code>
Python:
</code><code><code>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())
</code></code>
Parameters | |
---|---|
Name | Description |
request |
EscalateCaseRequest |
responseObserver |
io.grpc.stub.StreamObserver<Case> |
getCase(GetCaseRequest request, StreamObserver<Case> responseObserver)
public default void getCase(GetCaseRequest request, StreamObserver<Case> responseObserver)
Retrieve a case.
EXAMPLES:
cURL:
<code><code>shell
case="projects/some-project/cases/16033687"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$case"
</code></code><code>
Python:
</code><code><code>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())
</code></code>
Parameters | |
---|---|
Name | Description |
request |
GetCaseRequest |
responseObserver |
io.grpc.stub.StreamObserver<Case> |
listCases(ListCasesRequest request, StreamObserver<ListCasesResponse> responseObserver)
public default void listCases(ListCasesRequest request, StreamObserver<ListCasesResponse> responseObserver)
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:
<code><code>shell
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases"
</code></code><code>
Python:
</code><code><code>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())
</code></code>
Parameters | |
---|---|
Name | Description |
request |
ListCasesRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListCasesResponse> |
searchCaseClassifications(SearchCaseClassificationsRequest request, StreamObserver<SearchCaseClassificationsResponse> responseObserver)
public default void searchCaseClassifications(SearchCaseClassificationsRequest request, StreamObserver<SearchCaseClassificationsResponse> responseObserver)
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:
<code><code>shell
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"'
</code></code><code>
Python:
</code><code><code>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())
</code></code>
Parameters | |
---|---|
Name | Description |
request |
SearchCaseClassificationsRequest |
responseObserver |
io.grpc.stub.StreamObserver<SearchCaseClassificationsResponse> |
searchCases(SearchCasesRequest request, StreamObserver<SearchCasesResponse> responseObserver)
public default void searchCases(SearchCasesRequest request, StreamObserver<SearchCasesResponse> responseObserver)
Search for cases using a query.
EXAMPLES:
cURL:
<code><code>shell
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases:search"
</code></code><code>
Python:
</code><code><code>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())
</code></code>
Parameters | |
---|---|
Name | Description |
request |
SearchCasesRequest |
responseObserver |
io.grpc.stub.StreamObserver<SearchCasesResponse> |
updateCase(UpdateCaseRequest request, StreamObserver<Case> responseObserver)
public default void updateCase(UpdateCaseRequest request, StreamObserver<Case> responseObserver)
Update a case. Only some fields can be updated.
EXAMPLES:
cURL:
<code><code>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"
</code></code><code>
Python:
</code><code><code>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())
</code></code>
Parameters | |
---|---|
Name | Description |
request |
UpdateCaseRequest |
responseObserver |
io.grpc.stub.StreamObserver<Case> |