Show / Hide Table of Contents

Class CasesResource.SearchRequest

Search for cases using a query. EXAMPLES: cURL:

shell parent="projects/some-project" curl \ --header
"Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$parent/cases:search"

Python:

python import
googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build(
serviceName="cloudsupport", version=api_version,
discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request
= supportApiService.cases().search( parent="projects/some-project", query="state=OPEN" )
print(request.execute())
Inheritance
object
ClientServiceRequest
ClientServiceRequest<SearchCasesResponse>
CloudSupportBaseServiceRequest<SearchCasesResponse>
CasesResource.SearchRequest
Implements
IClientServiceRequest<SearchCasesResponse>
IClientServiceRequest
Inherited Members
CloudSupportBaseServiceRequest<SearchCasesResponse>.Xgafv
CloudSupportBaseServiceRequest<SearchCasesResponse>.AccessToken
CloudSupportBaseServiceRequest<SearchCasesResponse>.Alt
CloudSupportBaseServiceRequest<SearchCasesResponse>.Callback
CloudSupportBaseServiceRequest<SearchCasesResponse>.Fields
CloudSupportBaseServiceRequest<SearchCasesResponse>.Key
CloudSupportBaseServiceRequest<SearchCasesResponse>.OauthToken
CloudSupportBaseServiceRequest<SearchCasesResponse>.PrettyPrint
CloudSupportBaseServiceRequest<SearchCasesResponse>.QuotaUser
CloudSupportBaseServiceRequest<SearchCasesResponse>.UploadType
CloudSupportBaseServiceRequest<SearchCasesResponse>.UploadProtocol
ClientServiceRequest<SearchCasesResponse>.Execute()
ClientServiceRequest<SearchCasesResponse>.ExecuteAsStream()
ClientServiceRequest<SearchCasesResponse>.ExecuteAsync()
ClientServiceRequest<SearchCasesResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<SearchCasesResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<SearchCasesResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<SearchCasesResponse>.CreateRequest(bool?)
ClientServiceRequest<SearchCasesResponse>.GenerateRequestUri()
ClientServiceRequest<SearchCasesResponse>.GetBody()
ClientServiceRequest<SearchCasesResponse>.GetDefaultETagAction(string)
ClientServiceRequest<SearchCasesResponse>.ETagAction
ClientServiceRequest<SearchCasesResponse>.ModifyRequest
ClientServiceRequest<SearchCasesResponse>.ValidateParameters
ClientServiceRequest<SearchCasesResponse>.ApiVersion
ClientServiceRequest<SearchCasesResponse>.RequestParameters
ClientServiceRequest<SearchCasesResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudSupport.v2
Assembly: Google.Apis.CloudSupport.v2.dll
Syntax
public class CasesResource.SearchRequest : CloudSupportBaseServiceRequest<SearchCasesResponse>, IClientServiceRequest<SearchCasesResponse>, IClientServiceRequest

Constructors

SearchRequest(IClientService, string)

Constructs a new Search request.

Declaration
public SearchRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<SearchCasesResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<SearchCasesResponse>.MethodName

PageSize

The maximum number of cases fetched with each request. The default page size is 10.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

A token identifying the page of results to return. If unspecified, the first page is retrieved.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

The name of the parent resource to search for cases under.

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

Query

An expression used to filter cases. Expressions use the following fields separated by AND and specified with =: - state: Can be OPEN or CLOSED. - priority: Can be P0, P1, P2, P3, or P4. You can specify multiple values for priority using the OR operator. For example, priority=P1 OR priority=P2. - creator.email: The email address of the case creator. To search across displayName, description, and comments, use a global restriction with no keyword or operator. For example, "my search". To search only cases updated after a certain date, use update_time restricted with that particular date, time, and timezone in ISO datetime format. For example, update_time&gt;"2020-01-01T00:00:00-05:00". update_time only supports the greater than operator (&gt;). If you are using the v2 version of the API, you must specify the case parent in the parent field. If you provide an empty query, all cases under the parent resource will be returned. If you are using the v2beta version of the API, you must specify the case parent in the query field using one of the two fields below, which are only available for v2beta. The parent field will be ignored. - organization: An organization name in the form organizations/. - project: A project name in the form projects/. Examples: For v2: - state=CLOSED - state=OPEN AND creator.email="tester@example.com" - state=OPEN AND (priority=P0 OR priority=P1) - update_time&gt;"2020-01-01T00:00:00-05:00" For v2beta: - organization="organizations/123456789" - project="projects/my-project-id" - project="projects/123456789" - organization="organizations/123456789" AND state=CLOSED - project="projects/my-project-id" AND creator.email="tester@example.com" - project="projects/my-project-id" AND (priority=P0 OR priority=P1)

Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<SearchCasesResponse>.RestPath

Methods

InitParameters()

Initializes Search parameter list.

Declaration
protected override void InitParameters()
Overrides
CloudSupportBaseServiceRequest<SearchCasesResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX