public abstract class CaseServiceClient
Reference documentation and code samples for the Google Cloud Support v2 API class CaseServiceClient.
CaseService client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.Support.V2Assembly
Google.Cloud.Support.V2.dll
Remarks
A service to manage Google Cloud support cases.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the CaseService service, which is a host of "cloudsupport.googleapis.com" and a port of 443.
Property Value | |
---|---|
Type | Description |
string |
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }
The default CaseService scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default CaseService scopes are:
GrpcClient
public virtual CaseService.CaseServiceClient GrpcClient { get; }
The underlying gRPC CaseService client
Property Value | |
---|---|
Type | Description |
CaseServiceCaseServiceClient |
ServiceMetadata
public static ServiceMetadata ServiceMetadata { get; }
The service metadata associated with this client type.
Property Value | |
---|---|
Type | Description |
ServiceMetadata |
Methods
CloseCase(CloseCaseRequest, CallSettings)
public virtual Case CloseCase(CloseCaseRequest request, CallSettings callSettings = null)
Close a case.
EXAMPLES:
cURL:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
CloseCaseRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Case |
The RPC response. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
CloseCaseRequest request = new CloseCaseRequest
{
CaseName = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]"),
};
// Make the request
Case response = caseServiceClient.CloseCase(request);
CloseCaseAsync(CloseCaseRequest, CallSettings)
public virtual Task<Case> CloseCaseAsync(CloseCaseRequest request, CallSettings callSettings = null)
Close a case.
EXAMPLES:
cURL:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
CloseCaseRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
CloseCaseRequest request = new CloseCaseRequest
{
CaseName = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]"),
};
// Make the request
Case response = await caseServiceClient.CloseCaseAsync(request);
CloseCaseAsync(CloseCaseRequest, CancellationToken)
public virtual Task<Case> CloseCaseAsync(CloseCaseRequest request, CancellationToken cancellationToken)
Close a case.
EXAMPLES:
cURL:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
CloseCaseRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
CloseCaseRequest request = new CloseCaseRequest
{
CaseName = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]"),
};
// Make the request
Case response = await caseServiceClient.CloseCaseAsync(request);
Create()
public static CaseServiceClient Create()
Synchronously creates a CaseServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CaseServiceClientBuilder.
Returns | |
---|---|
Type | Description |
CaseServiceClient |
The created CaseServiceClient. |
CreateAsync(CancellationToken)
public static Task<CaseServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Asynchronously creates a CaseServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CaseServiceClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken |
CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
TaskCaseServiceClient |
The task representing the created CaseServiceClient. |
CreateCase(OrganizationName, Case, CallSettings)
public virtual Case CreateCase(OrganizationName parent, Case @case, CallSettings callSettings = null)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
parent |
OrganizationName Required. The name of the parent under which the case should be created. |
case |
Case Required. The case to be created. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Case |
The RPC response. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
Case @case = new Case();
// Make the request
Case response = caseServiceClient.CreateCase(parent, @case);
CreateCase(ProjectName, Case, CallSettings)
public virtual Case CreateCase(ProjectName parent, Case @case, CallSettings callSettings = null)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The name of the parent under which the case should be created. |
case |
Case Required. The case to be created. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Case |
The RPC response. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Case @case = new Case();
// Make the request
Case response = caseServiceClient.CreateCase(parent, @case);
CreateCase(CreateCaseRequest, CallSettings)
public virtual Case CreateCase(CreateCaseRequest request, CallSettings callSettings = null)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
CreateCaseRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Case |
The RPC response. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
CreateCaseRequest request = new CreateCaseRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
Case = new Case(),
};
// Make the request
Case response = caseServiceClient.CreateCase(request);
CreateCase(string, Case, CallSettings)
public virtual Case CreateCase(string parent, Case @case, CallSettings callSettings = null)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
parent |
string Required. The name of the parent under which the case should be created. |
case |
Case Required. The case to be created. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Case |
The RPC response. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
Case @case = new Case();
// Make the request
Case response = caseServiceClient.CreateCase(parent, @case);
CreateCaseAsync(OrganizationName, Case, CallSettings)
public virtual Task<Case> CreateCaseAsync(OrganizationName parent, Case @case, CallSettings callSettings = null)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
parent |
OrganizationName Required. The name of the parent under which the case should be created. |
case |
Case Required. The case to be created. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
Case @case = new Case();
// Make the request
Case response = await caseServiceClient.CreateCaseAsync(parent, @case);
CreateCaseAsync(OrganizationName, Case, CancellationToken)
public virtual Task<Case> CreateCaseAsync(OrganizationName parent, Case @case, CancellationToken cancellationToken)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
parent |
OrganizationName Required. The name of the parent under which the case should be created. |
case |
Case Required. The case to be created. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
Case @case = new Case();
// Make the request
Case response = await caseServiceClient.CreateCaseAsync(parent, @case);
CreateCaseAsync(ProjectName, Case, CallSettings)
public virtual Task<Case> CreateCaseAsync(ProjectName parent, Case @case, CallSettings callSettings = null)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The name of the parent under which the case should be created. |
case |
Case Required. The case to be created. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Case @case = new Case();
// Make the request
Case response = await caseServiceClient.CreateCaseAsync(parent, @case);
CreateCaseAsync(ProjectName, Case, CancellationToken)
public virtual Task<Case> CreateCaseAsync(ProjectName parent, Case @case, CancellationToken cancellationToken)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The name of the parent under which the case should be created. |
case |
Case Required. The case to be created. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Case @case = new Case();
// Make the request
Case response = await caseServiceClient.CreateCaseAsync(parent, @case);
CreateCaseAsync(CreateCaseRequest, CallSettings)
public virtual Task<Case> CreateCaseAsync(CreateCaseRequest request, CallSettings callSettings = null)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
CreateCaseRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
CreateCaseRequest request = new CreateCaseRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
Case = new Case(),
};
// Make the request
Case response = await caseServiceClient.CreateCaseAsync(request);
CreateCaseAsync(CreateCaseRequest, CancellationToken)
public virtual Task<Case> CreateCaseAsync(CreateCaseRequest request, CancellationToken cancellationToken)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
CreateCaseRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
CreateCaseRequest request = new CreateCaseRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
Case = new Case(),
};
// Make the request
Case response = await caseServiceClient.CreateCaseAsync(request);
CreateCaseAsync(string, Case, CallSettings)
public virtual Task<Case> CreateCaseAsync(string parent, Case @case, CallSettings callSettings = null)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
parent |
string Required. The name of the parent under which the case should be created. |
case |
Case Required. The case to be created. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
Case @case = new Case();
// Make the request
Case response = await caseServiceClient.CreateCaseAsync(parent, @case);
CreateCaseAsync(string, Case, CancellationToken)
public virtual Task<Case> CreateCaseAsync(string parent, Case @case, CancellationToken cancellationToken)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
parent |
string Required. The name of the parent under which the case should be created. |
case |
Case Required. The case to be created. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
Case @case = new Case();
// Make the request
Case response = await caseServiceClient.CreateCaseAsync(parent, @case);
EscalateCase(EscalateCaseRequest, CallSettings)
public virtual Case EscalateCase(EscalateCaseRequest request, CallSettings callSettings = null)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
EscalateCaseRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Case |
The RPC response. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
EscalateCaseRequest request = new EscalateCaseRequest
{
CaseName = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]"),
Escalation = new Escalation(),
};
// Make the request
Case response = caseServiceClient.EscalateCase(request);
EscalateCaseAsync(EscalateCaseRequest, CallSettings)
public virtual Task<Case> EscalateCaseAsync(EscalateCaseRequest request, CallSettings callSettings = null)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
EscalateCaseRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
EscalateCaseRequest request = new EscalateCaseRequest
{
CaseName = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]"),
Escalation = new Escalation(),
};
// Make the request
Case response = await caseServiceClient.EscalateCaseAsync(request);
EscalateCaseAsync(EscalateCaseRequest, CancellationToken)
public virtual Task<Case> EscalateCaseAsync(EscalateCaseRequest request, CancellationToken cancellationToken)
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:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
EscalateCaseRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
EscalateCaseRequest request = new EscalateCaseRequest
{
CaseName = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]"),
Escalation = new Escalation(),
};
// Make the request
Case response = await caseServiceClient.EscalateCaseAsync(request);
GetCase(CaseName, CallSettings)
public virtual Case GetCase(CaseName name, CallSettings callSettings = null)
Retrieve a case.
EXAMPLES:
cURL:
case="projects/some-project/cases/16033687"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$case"
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())
Parameters | |
---|---|
Name | Description |
name |
CaseName Required. The full name of a case to be retrieved. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Case |
The RPC response. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
CaseName name = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]");
// Make the request
Case response = caseServiceClient.GetCase(name);
GetCase(GetCaseRequest, CallSettings)
public virtual Case GetCase(GetCaseRequest request, CallSettings callSettings = null)
Retrieve a case.
EXAMPLES:
cURL:
case="projects/some-project/cases/16033687"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$case"
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())
Parameters | |
---|---|
Name | Description |
request |
GetCaseRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Case |
The RPC response. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
GetCaseRequest request = new GetCaseRequest
{
CaseName = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]"),
};
// Make the request
Case response = caseServiceClient.GetCase(request);
GetCase(string, CallSettings)
public virtual Case GetCase(string name, CallSettings callSettings = null)
Retrieve a case.
EXAMPLES:
cURL:
case="projects/some-project/cases/16033687"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$case"
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())
Parameters | |
---|---|
Name | Description |
name |
string Required. The full name of a case to be retrieved. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Case |
The RPC response. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/cases/[CASE]";
// Make the request
Case response = caseServiceClient.GetCase(name);
GetCaseAsync(CaseName, CallSettings)
public virtual Task<Case> GetCaseAsync(CaseName name, CallSettings callSettings = null)
Retrieve a case.
EXAMPLES:
cURL:
case="projects/some-project/cases/16033687"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$case"
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())
Parameters | |
---|---|
Name | Description |
name |
CaseName Required. The full name of a case to be retrieved. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
CaseName name = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]");
// Make the request
Case response = await caseServiceClient.GetCaseAsync(name);
GetCaseAsync(CaseName, CancellationToken)
public virtual Task<Case> GetCaseAsync(CaseName name, CancellationToken cancellationToken)
Retrieve a case.
EXAMPLES:
cURL:
case="projects/some-project/cases/16033687"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$case"
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())
Parameters | |
---|---|
Name | Description |
name |
CaseName Required. The full name of a case to be retrieved. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
CaseName name = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]");
// Make the request
Case response = await caseServiceClient.GetCaseAsync(name);
GetCaseAsync(GetCaseRequest, CallSettings)
public virtual Task<Case> GetCaseAsync(GetCaseRequest request, CallSettings callSettings = null)
Retrieve a case.
EXAMPLES:
cURL:
case="projects/some-project/cases/16033687"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$case"
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())
Parameters | |
---|---|
Name | Description |
request |
GetCaseRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
GetCaseRequest request = new GetCaseRequest
{
CaseName = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]"),
};
// Make the request
Case response = await caseServiceClient.GetCaseAsync(request);
GetCaseAsync(GetCaseRequest, CancellationToken)
public virtual Task<Case> GetCaseAsync(GetCaseRequest request, CancellationToken cancellationToken)
Retrieve a case.
EXAMPLES:
cURL:
case="projects/some-project/cases/16033687"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$case"
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())
Parameters | |
---|---|
Name | Description |
request |
GetCaseRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
GetCaseRequest request = new GetCaseRequest
{
CaseName = CaseName.FromOrganizationCase("[ORGANIZATION]", "[CASE]"),
};
// Make the request
Case response = await caseServiceClient.GetCaseAsync(request);
GetCaseAsync(string, CallSettings)
public virtual Task<Case> GetCaseAsync(string name, CallSettings callSettings = null)
Retrieve a case.
EXAMPLES:
cURL:
case="projects/some-project/cases/16033687"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$case"
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())
Parameters | |
---|---|
Name | Description |
name |
string Required. The full name of a case to be retrieved. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/cases/[CASE]";
// Make the request
Case response = await caseServiceClient.GetCaseAsync(name);
GetCaseAsync(string, CancellationToken)
public virtual Task<Case> GetCaseAsync(string name, CancellationToken cancellationToken)
Retrieve a case.
EXAMPLES:
cURL:
case="projects/some-project/cases/16033687"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$case"
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())
Parameters | |
---|---|
Name | Description |
name |
string Required. The full name of a case to be retrieved. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/cases/[CASE]";
// Make the request
Case response = await caseServiceClient.GetCaseAsync(name);
ListCases(OrganizationName, string, int?, CallSettings)
public virtual PagedEnumerable<ListCasesResponse, Case> ListCases(OrganizationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
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:
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases"
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())
Parameters | |
---|---|
Name | Description |
parent |
OrganizationName Required. The name of a parent to list cases under. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListCasesResponseCase |
A pageable sequence of Case resources. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
PagedEnumerable<ListCasesResponse, Case> response = caseServiceClient.ListCases(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Case item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListCasesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Case item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Case> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Case item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListCases(ProjectName, string, int?, CallSettings)
public virtual PagedEnumerable<ListCasesResponse, Case> ListCases(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
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:
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases"
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())
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The name of a parent to list cases under. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListCasesResponseCase |
A pageable sequence of Case resources. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListCasesResponse, Case> response = caseServiceClient.ListCases(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Case item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListCasesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Case item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Case> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Case item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListCases(ListCasesRequest, CallSettings)
public virtual PagedEnumerable<ListCasesResponse, Case> ListCases(ListCasesRequest request, CallSettings callSettings = null)
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:
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases"
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())
Parameters | |
---|---|
Name | Description |
request |
ListCasesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListCasesResponseCase |
A pageable sequence of Case resources. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
ListCasesRequest request = new ListCasesRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
Filter = "",
};
// Make the request
PagedEnumerable<ListCasesResponse, Case> response = caseServiceClient.ListCases(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Case item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListCasesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Case item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Case> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Case item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListCases(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListCasesResponse, Case> ListCases(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
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:
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases"
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())
Parameters | |
---|---|
Name | Description |
parent |
string Required. The name of a parent to list cases under. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListCasesResponseCase |
A pageable sequence of Case resources. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
// Make the request
PagedEnumerable<ListCasesResponse, Case> response = caseServiceClient.ListCases(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Case item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListCasesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Case item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Case> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Case item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListCasesAsync(OrganizationName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListCasesResponse, Case> ListCasesAsync(OrganizationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
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:
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases"
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())
Parameters | |
---|---|
Name | Description |
parent |
OrganizationName Required. The name of a parent to list cases under. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListCasesResponseCase |
A pageable asynchronous sequence of Case resources. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName parent = OrganizationName.FromOrganization("[ORGANIZATION]");
// Make the request
PagedAsyncEnumerable<ListCasesResponse, Case> response = caseServiceClient.ListCasesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Case item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListCasesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Case item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Case> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Case item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListCasesAsync(ProjectName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListCasesResponse, Case> ListCasesAsync(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
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:
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases"
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())
Parameters | |
---|---|
Name | Description |
parent |
ProjectName Required. The name of a parent to list cases under. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListCasesResponseCase |
A pageable asynchronous sequence of Case resources. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListCasesResponse, Case> response = caseServiceClient.ListCasesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Case item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListCasesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Case item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Case> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Case item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListCasesAsync(ListCasesRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListCasesResponse, Case> ListCasesAsync(ListCasesRequest request, CallSettings callSettings = null)
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:
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases"
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())
Parameters | |
---|---|
Name | Description |
request |
ListCasesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListCasesResponseCase |
A pageable asynchronous sequence of Case resources. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
ListCasesRequest request = new ListCasesRequest
{
ParentAsOrganizationName = OrganizationName.FromOrganization("[ORGANIZATION]"),
Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListCasesResponse, Case> response = caseServiceClient.ListCasesAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Case item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListCasesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Case item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Case> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Case item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ListCasesAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListCasesResponse, Case> ListCasesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
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:
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases"
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())
Parameters | |
---|---|
Name | Description |
parent |
string Required. The name of a parent to list cases under. |
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListCasesResponseCase |
A pageable asynchronous sequence of Case resources. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]";
// Make the request
PagedAsyncEnumerable<ListCasesResponse, Case> response = caseServiceClient.ListCasesAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Case item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListCasesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Case item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Case> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Case item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchCaseClassifications(SearchCaseClassificationsRequest, CallSettings)
public virtual PagedEnumerable<SearchCaseClassificationsResponse, CaseClassification> SearchCaseClassifications(SearchCaseClassificationsRequest request, CallSettings callSettings = null)
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:
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"'
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())
Parameters | |
---|---|
Name | Description |
request |
SearchCaseClassificationsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableSearchCaseClassificationsResponseCaseClassification |
A pageable sequence of CaseClassification resources. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
SearchCaseClassificationsRequest request = new SearchCaseClassificationsRequest { Query = "", };
// Make the request
PagedEnumerable<SearchCaseClassificationsResponse, CaseClassification> response = caseServiceClient.SearchCaseClassifications(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (CaseClassification item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchCaseClassificationsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (CaseClassification item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<CaseClassification> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (CaseClassification item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchCaseClassificationsAsync(SearchCaseClassificationsRequest, CallSettings)
public virtual PagedAsyncEnumerable<SearchCaseClassificationsResponse, CaseClassification> SearchCaseClassificationsAsync(SearchCaseClassificationsRequest request, CallSettings callSettings = null)
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:
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"'
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())
Parameters | |
---|---|
Name | Description |
request |
SearchCaseClassificationsRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableSearchCaseClassificationsResponseCaseClassification |
A pageable asynchronous sequence of CaseClassification resources. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
SearchCaseClassificationsRequest request = new SearchCaseClassificationsRequest { Query = "", };
// Make the request
PagedAsyncEnumerable<SearchCaseClassificationsResponse, CaseClassification> response = caseServiceClient.SearchCaseClassificationsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((CaseClassification item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchCaseClassificationsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (CaseClassification item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<CaseClassification> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (CaseClassification item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchCases(SearchCasesRequest, CallSettings)
public virtual PagedEnumerable<SearchCasesResponse, Case> SearchCases(SearchCasesRequest request, CallSettings callSettings = null)
Search for cases using a query.
EXAMPLES:
cURL:
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases:search"
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())
Parameters | |
---|---|
Name | Description |
request |
SearchCasesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableSearchCasesResponseCase |
A pageable sequence of Case resources. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
SearchCasesRequest request = new SearchCasesRequest
{
Query = "",
Parent = "",
};
// Make the request
PagedEnumerable<SearchCasesResponse, Case> response = caseServiceClient.SearchCases(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Case item in response)
{
// Do something with each item
Console.WriteLine(item);
}
// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchCasesResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Case item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Case> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Case item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
SearchCasesAsync(SearchCasesRequest, CallSettings)
public virtual PagedAsyncEnumerable<SearchCasesResponse, Case> SearchCasesAsync(SearchCasesRequest request, CallSettings callSettings = null)
Search for cases using a query.
EXAMPLES:
cURL:
parent="projects/some-project"
curl \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases:search"
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())
Parameters | |
---|---|
Name | Description |
request |
SearchCasesRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableSearchCasesResponseCase |
A pageable asynchronous sequence of Case resources. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
SearchCasesRequest request = new SearchCasesRequest
{
Query = "",
Parent = "",
};
// Make the request
PagedAsyncEnumerable<SearchCasesResponse, Case> response = caseServiceClient.SearchCasesAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Case item) =>
{
// Do something with each item
Console.WriteLine(item);
});
// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchCasesResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Case item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});
// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Case> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Case item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
Returns | |
---|---|
Type | Description |
Task |
A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
UpdateCase(Case, FieldMask, CallSettings)
public virtual Case UpdateCase(Case @case, FieldMask updateMask, CallSettings callSettings = null)
Update a case. Only some fields can be updated.
EXAMPLES:
cURL:
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:
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())
Parameters | |
---|---|
Name | Description |
case |
Case Required. The case to update. |
updateMask |
FieldMask A list of attributes of the case that should be updated. Supported values
are 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 |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Case |
The RPC response. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
Case @case = new Case();
FieldMask updateMask = new FieldMask();
// Make the request
Case response = caseServiceClient.UpdateCase(@case, updateMask);
UpdateCase(UpdateCaseRequest, CallSettings)
public virtual Case UpdateCase(UpdateCaseRequest request, CallSettings callSettings = null)
Update a case. Only some fields can be updated.
EXAMPLES:
cURL:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
UpdateCaseRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Case |
The RPC response. |
// Create client
CaseServiceClient caseServiceClient = CaseServiceClient.Create();
// Initialize request argument(s)
UpdateCaseRequest request = new UpdateCaseRequest
{
Case = new Case(),
UpdateMask = new FieldMask(),
};
// Make the request
Case response = caseServiceClient.UpdateCase(request);
UpdateCaseAsync(Case, FieldMask, CallSettings)
public virtual Task<Case> UpdateCaseAsync(Case @case, FieldMask updateMask, CallSettings callSettings = null)
Update a case. Only some fields can be updated.
EXAMPLES:
cURL:
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:
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())
Parameters | |
---|---|
Name | Description |
case |
Case Required. The case to update. |
updateMask |
FieldMask A list of attributes of the case that should be updated. Supported values
are 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 |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
Case @case = new Case();
FieldMask updateMask = new FieldMask();
// Make the request
Case response = await caseServiceClient.UpdateCaseAsync(@case, updateMask);
UpdateCaseAsync(Case, FieldMask, CancellationToken)
public virtual Task<Case> UpdateCaseAsync(Case @case, FieldMask updateMask, CancellationToken cancellationToken)
Update a case. Only some fields can be updated.
EXAMPLES:
cURL:
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:
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())
Parameters | |
---|---|
Name | Description |
case |
Case Required. The case to update. |
updateMask |
FieldMask A list of attributes of the case that should be updated. Supported values
are 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 |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
Case @case = new Case();
FieldMask updateMask = new FieldMask();
// Make the request
Case response = await caseServiceClient.UpdateCaseAsync(@case, updateMask);
UpdateCaseAsync(UpdateCaseRequest, CallSettings)
public virtual Task<Case> UpdateCaseAsync(UpdateCaseRequest request, CallSettings callSettings = null)
Update a case. Only some fields can be updated.
EXAMPLES:
cURL:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
UpdateCaseRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateCaseRequest request = new UpdateCaseRequest
{
Case = new Case(),
UpdateMask = new FieldMask(),
};
// Make the request
Case response = await caseServiceClient.UpdateCaseAsync(request);
UpdateCaseAsync(UpdateCaseRequest, CancellationToken)
public virtual Task<Case> UpdateCaseAsync(UpdateCaseRequest request, CancellationToken cancellationToken)
Update a case. Only some fields can be updated.
EXAMPLES:
cURL:
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:
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())
Parameters | |
---|---|
Name | Description |
request |
UpdateCaseRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCase |
A Task containing the RPC response. |
// Create client
CaseServiceClient caseServiceClient = await CaseServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateCaseRequest request = new UpdateCaseRequest
{
Case = new Case(),
UpdateMask = new FieldMask(),
};
// Make the request
Case response = await caseServiceClient.UpdateCaseAsync(request);