Google Cloud Support v2 API - Class CaseService.CaseServiceClient (1.3.0)

public class CaseService.CaseServiceClient : ClientBase<CaseService.CaseServiceClient>

Reference documentation and code samples for the Google Cloud Support v2 API class CaseService.CaseServiceClient.

Client for CaseService

Inheritance

object > ClientBase > ClientBaseCaseServiceCaseServiceClient > CaseService.CaseServiceClient

Namespace

Google.Cloud.Support.V2

Assembly

Google.Cloud.Support.V2.dll

Constructors

CaseServiceClient()

protected CaseServiceClient()

Protected parameterless constructor to allow creation of test doubles.

CaseServiceClient(CallInvoker)

public CaseServiceClient(CallInvoker callInvoker)

Creates a new client for CaseService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

CaseServiceClient(ChannelBase)

public CaseServiceClient(ChannelBase channel)

Creates a new client for CaseService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

CaseServiceClient(ClientBaseConfiguration)

protected CaseServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CloseCase(CloseCaseRequest, CallOptions)

public virtual Case CloseCase(CloseCaseRequest request, CallOptions options)

Close the specified case.

Parameters
Name Description
request CloseCaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Case

The response received from the server.

CloseCase(CloseCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Case CloseCase(CloseCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Close the specified case.

Parameters
Name Description
request CloseCaseRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Case

The response received from the server.

CloseCaseAsync(CloseCaseRequest, CallOptions)

public virtual AsyncUnaryCall<Case> CloseCaseAsync(CloseCaseRequest request, CallOptions options)

Close the specified case.

Parameters
Name Description
request CloseCaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCase

The call object.

CloseCaseAsync(CloseCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Case> CloseCaseAsync(CloseCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Close the specified case.

Parameters
Name Description
request CloseCaseRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallCase

The call object.

CreateCase(CreateCaseRequest, CallOptions)

public virtual Case CreateCase(CreateCaseRequest request, CallOptions options)

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

Parameters
Name Description
request CreateCaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Case

The response received from the server.

CreateCase(CreateCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Case CreateCase(CreateCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request CreateCaseRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Case

The response received from the server.

CreateCaseAsync(CreateCaseRequest, CallOptions)

public virtual AsyncUnaryCall<Case> CreateCaseAsync(CreateCaseRequest request, CallOptions options)

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

Parameters
Name Description
request CreateCaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCase

The call object.

CreateCaseAsync(CreateCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Case> CreateCaseAsync(CreateCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request CreateCaseRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallCase

The call object.

EscalateCase(EscalateCaseRequest, CallOptions)

public virtual Case EscalateCase(EscalateCaseRequest request, CallOptions options)

Escalate a case. Escalating a case will initiate the Google Cloud Support escalation management process.

This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.

Parameters
Name Description
request EscalateCaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Case

The response received from the server.

EscalateCase(EscalateCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Case EscalateCase(EscalateCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Escalate a case. Escalating a case will initiate the Google Cloud Support escalation management process.

This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.

Parameters
Name Description
request EscalateCaseRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Case

The response received from the server.

EscalateCaseAsync(EscalateCaseRequest, CallOptions)

public virtual AsyncUnaryCall<Case> EscalateCaseAsync(EscalateCaseRequest request, CallOptions options)

Escalate a case. Escalating a case will initiate the Google Cloud Support escalation management process.

This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.

Parameters
Name Description
request EscalateCaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCase

The call object.

EscalateCaseAsync(EscalateCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Case> EscalateCaseAsync(EscalateCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Escalate a case. Escalating a case will initiate the Google Cloud Support escalation management process.

This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.

Parameters
Name Description
request EscalateCaseRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallCase

The call object.

GetCase(GetCaseRequest, CallOptions)

public virtual Case GetCase(GetCaseRequest request, CallOptions options)

Retrieve the specified case.

Parameters
Name Description
request GetCaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Case

The response received from the server.

GetCase(GetCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Case GetCase(GetCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve the specified case.

Parameters
Name Description
request GetCaseRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Case

The response received from the server.

GetCaseAsync(GetCaseRequest, CallOptions)

public virtual AsyncUnaryCall<Case> GetCaseAsync(GetCaseRequest request, CallOptions options)

Retrieve the specified case.

Parameters
Name Description
request GetCaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCase

The call object.

GetCaseAsync(GetCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Case> GetCaseAsync(GetCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve the specified case.

Parameters
Name Description
request GetCaseRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallCase

The call object.

ListCases(ListCasesRequest, CallOptions)

public virtual ListCasesResponse ListCases(ListCasesRequest request, CallOptions options)

Retrieve all cases under the specified parent.

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

Parameters
Name Description
request ListCasesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListCasesResponse

The response received from the server.

ListCases(ListCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCasesResponse ListCases(ListCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve all cases under the specified parent.

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

Parameters
Name Description
request ListCasesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListCasesResponse

The response received from the server.

ListCasesAsync(ListCasesRequest, CallOptions)

public virtual AsyncUnaryCall<ListCasesResponse> ListCasesAsync(ListCasesRequest request, CallOptions options)

Retrieve all cases under the specified parent.

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

Parameters
Name Description
request ListCasesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListCasesResponse

The call object.

ListCasesAsync(ListCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCasesResponse> ListCasesAsync(ListCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve all cases under the specified parent.

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

Parameters
Name Description
request ListCasesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListCasesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override CaseService.CaseServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
CaseServiceCaseServiceClient
Overrides

SearchCaseClassifications(SearchCaseClassificationsRequest, CallOptions)

public virtual SearchCaseClassificationsResponse SearchCaseClassifications(SearchCaseClassificationsRequest request, CallOptions options)

Retrieve valid classifications to be used when creating a support case. The classications are hierarchical, with each classification containing all levels of the hierarchy, separated by " > ". For example "Technical Issue > Compute > Compute Engine".

Parameters
Name Description
request SearchCaseClassificationsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SearchCaseClassificationsResponse

The response received from the server.

SearchCaseClassifications(SearchCaseClassificationsRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchCaseClassificationsResponse SearchCaseClassifications(SearchCaseClassificationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve valid classifications to be used when creating a support case. The classications are hierarchical, with each classification containing all levels of the hierarchy, separated by " > ". For example "Technical Issue > Compute > Compute Engine".

Parameters
Name Description
request SearchCaseClassificationsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
SearchCaseClassificationsResponse

The response received from the server.

SearchCaseClassificationsAsync(SearchCaseClassificationsRequest, CallOptions)

public virtual AsyncUnaryCall<SearchCaseClassificationsResponse> SearchCaseClassificationsAsync(SearchCaseClassificationsRequest request, CallOptions options)

Retrieve valid classifications to be used when creating a support case. The classications are hierarchical, with each classification containing all levels of the hierarchy, separated by " > ". For example "Technical Issue > Compute > Compute Engine".

Parameters
Name Description
request SearchCaseClassificationsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSearchCaseClassificationsResponse

The call object.

SearchCaseClassificationsAsync(SearchCaseClassificationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchCaseClassificationsResponse> SearchCaseClassificationsAsync(SearchCaseClassificationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve valid classifications to be used when creating a support case. The classications are hierarchical, with each classification containing all levels of the hierarchy, separated by " > ". For example "Technical Issue > Compute > Compute Engine".

Parameters
Name Description
request SearchCaseClassificationsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSearchCaseClassificationsResponse

The call object.

SearchCases(SearchCasesRequest, CallOptions)

public virtual SearchCasesResponse SearchCases(SearchCasesRequest request, CallOptions options)

Search cases using the specified query.

Parameters
Name Description
request SearchCasesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SearchCasesResponse

The response received from the server.

SearchCases(SearchCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchCasesResponse SearchCases(SearchCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Search cases using the specified query.

Parameters
Name Description
request SearchCasesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
SearchCasesResponse

The response received from the server.

SearchCasesAsync(SearchCasesRequest, CallOptions)

public virtual AsyncUnaryCall<SearchCasesResponse> SearchCasesAsync(SearchCasesRequest request, CallOptions options)

Search cases using the specified query.

Parameters
Name Description
request SearchCasesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSearchCasesResponse

The call object.

SearchCasesAsync(SearchCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchCasesResponse> SearchCasesAsync(SearchCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Search cases using the specified query.

Parameters
Name Description
request SearchCasesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSearchCasesResponse

The call object.

UpdateCase(UpdateCaseRequest, CallOptions)

public virtual Case UpdateCase(UpdateCaseRequest request, CallOptions options)

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

Parameters
Name Description
request UpdateCaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Case

The response received from the server.

UpdateCase(UpdateCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Case UpdateCase(UpdateCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request UpdateCaseRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Case

The response received from the server.

UpdateCaseAsync(UpdateCaseRequest, CallOptions)

public virtual AsyncUnaryCall<Case> UpdateCaseAsync(UpdateCaseRequest request, CallOptions options)

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

Parameters
Name Description
request UpdateCaseRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCase

The call object.

UpdateCaseAsync(UpdateCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Case> UpdateCaseAsync(UpdateCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request UpdateCaseRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallCase

The call object.