Class SearchCasesRequest.Builder (0.29.0)

public static final class SearchCasesRequest.Builder extends GeneratedMessageV3.Builder<SearchCasesRequest.Builder> implements SearchCasesRequestOrBuilder

The request message for the SearchCases endpoint.

Protobuf type google.cloud.support.v2.SearchCasesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchCasesRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchCasesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchCasesRequest.Builder
Overrides

build()

public SearchCasesRequest build()
Returns
Type Description
SearchCasesRequest

buildPartial()

public SearchCasesRequest buildPartial()
Returns
Type Description
SearchCasesRequest

clear()

public SearchCasesRequest.Builder clear()
Returns
Type Description
SearchCasesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchCasesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchCasesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchCasesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchCasesRequest.Builder
Overrides

clearPageSize()

public SearchCasesRequest.Builder clearPageSize()

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

int32 page_size = 2;

Returns
Type Description
SearchCasesRequest.Builder

This builder for chaining.

clearPageToken()

public SearchCasesRequest.Builder clearPageToken()

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

string page_token = 3;

Returns
Type Description
SearchCasesRequest.Builder

This builder for chaining.

clearParent()

public SearchCasesRequest.Builder clearParent()

The fully qualified name of parent resource to search cases under.

string parent = 4;

Returns
Type Description
SearchCasesRequest.Builder

This builder for chaining.

clearQuery()

public SearchCasesRequest.Builder clearQuery()

An expression written in filter language.

A query uses the following fields with the operators equals (=) and AND:

  • organization: An organization name in the form organizations/<organization_id>.
  • project: A project name in the form projects/<project_id>.
  • state: The accepted values are OPEN or CLOSED.
  • priority: The accepted values are P0, P1, P2, P3, or P4. You can specify multiple values for priority using the OR operator. For example, priority=P1 OR priority=P2.
  • creator.email: The email address of the case creator.

  • billingAccount: A billing account in the form billingAccounts/<billing_account_id>

    You must specify either organization or project.

    To search across displayName, description, and comments, use a global restriction with no keyword or operator. For example, "my search".

    To search only cases updated after a certain date, use update_time restricted with that particular date, time, and timezone in ISO datetime format. For example, update_time>"2020-01-01T00:00:00-05:00". update_time only supports the greater than operator (>).

    Examples:

  • organization="organizations/123456789"

  • project="projects/my-project-id"
  • project="projects/123456789"
  • billing_account="billingAccounts/123456-A0B0C0-CUZ789"
  • organization="organizations/123456789" AND state=CLOSED
  • project="projects/my-project-id" AND creator.email="tester@example.com"
  • project="projects/my-project-id" AND (priority=P0 OR priority=P1)

string query = 1;

Returns
Type Description
SearchCasesRequest.Builder

This builder for chaining.

clone()

public SearchCasesRequest.Builder clone()
Returns
Type Description
SearchCasesRequest.Builder
Overrides

getDefaultInstanceForType()

public SearchCasesRequest getDefaultInstanceForType()
Returns
Type Description
SearchCasesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

public int getPageSize()

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

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

The fully qualified name of parent resource to search cases under.

string parent = 4;

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

The fully qualified name of parent resource to search cases under.

string parent = 4;

Returns
Type Description
ByteString

The bytes for parent.

getQuery()

public String getQuery()

An expression written in filter language.

A query uses the following fields with the operators equals (=) and AND:

  • organization: An organization name in the form organizations/<organization_id>.
  • project: A project name in the form projects/<project_id>.
  • state: The accepted values are OPEN or CLOSED.
  • priority: The accepted values are P0, P1, P2, P3, or P4. You can specify multiple values for priority using the OR operator. For example, priority=P1 OR priority=P2.
  • creator.email: The email address of the case creator.

  • billingAccount: A billing account in the form billingAccounts/<billing_account_id>

    You must specify either organization or project.

    To search across displayName, description, and comments, use a global restriction with no keyword or operator. For example, "my search".

    To search only cases updated after a certain date, use update_time restricted with that particular date, time, and timezone in ISO datetime format. For example, update_time>"2020-01-01T00:00:00-05:00". update_time only supports the greater than operator (>).

    Examples:

  • organization="organizations/123456789"

  • project="projects/my-project-id"
  • project="projects/123456789"
  • billing_account="billingAccounts/123456-A0B0C0-CUZ789"
  • organization="organizations/123456789" AND state=CLOSED
  • project="projects/my-project-id" AND creator.email="tester@example.com"
  • project="projects/my-project-id" AND (priority=P0 OR priority=P1)

string query = 1;

Returns
Type Description
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

An expression written in filter language.

A query uses the following fields with the operators equals (=) and AND:

  • organization: An organization name in the form organizations/<organization_id>.
  • project: A project name in the form projects/<project_id>.
  • state: The accepted values are OPEN or CLOSED.
  • priority: The accepted values are P0, P1, P2, P3, or P4. You can specify multiple values for priority using the OR operator. For example, priority=P1 OR priority=P2.
  • creator.email: The email address of the case creator.

  • billingAccount: A billing account in the form billingAccounts/<billing_account_id>

    You must specify either organization or project.

    To search across displayName, description, and comments, use a global restriction with no keyword or operator. For example, "my search".

    To search only cases updated after a certain date, use update_time restricted with that particular date, time, and timezone in ISO datetime format. For example, update_time>"2020-01-01T00:00:00-05:00". update_time only supports the greater than operator (>).

    Examples:

  • organization="organizations/123456789"

  • project="projects/my-project-id"
  • project="projects/123456789"
  • billing_account="billingAccounts/123456-A0B0C0-CUZ789"
  • organization="organizations/123456789" AND state=CLOSED
  • project="projects/my-project-id" AND creator.email="tester@example.com"
  • project="projects/my-project-id" AND (priority=P0 OR priority=P1)

string query = 1;

Returns
Type Description
ByteString

The bytes for query.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchCasesRequest other)

public SearchCasesRequest.Builder mergeFrom(SearchCasesRequest other)
Parameter
Name Description
other SearchCasesRequest
Returns
Type Description
SearchCasesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchCasesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCasesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchCasesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchCasesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchCasesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchCasesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchCasesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchCasesRequest.Builder
Overrides

setPageSize(int value)

public SearchCasesRequest.Builder setPageSize(int value)

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

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
SearchCasesRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchCasesRequest.Builder setPageToken(String value)

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

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
SearchCasesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchCasesRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
SearchCasesRequest.Builder

This builder for chaining.

setParent(String value)

public SearchCasesRequest.Builder setParent(String value)

The fully qualified name of parent resource to search cases under.

string parent = 4;

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
SearchCasesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public SearchCasesRequest.Builder setParentBytes(ByteString value)

The fully qualified name of parent resource to search cases under.

string parent = 4;

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
SearchCasesRequest.Builder

This builder for chaining.

setQuery(String value)

public SearchCasesRequest.Builder setQuery(String value)

An expression written in filter language.

A query uses the following fields with the operators equals (=) and AND:

  • organization: An organization name in the form organizations/<organization_id>.
  • project: A project name in the form projects/<project_id>.
  • state: The accepted values are OPEN or CLOSED.
  • priority: The accepted values are P0, P1, P2, P3, or P4. You can specify multiple values for priority using the OR operator. For example, priority=P1 OR priority=P2.
  • creator.email: The email address of the case creator.

  • billingAccount: A billing account in the form billingAccounts/<billing_account_id>

    You must specify either organization or project.

    To search across displayName, description, and comments, use a global restriction with no keyword or operator. For example, "my search".

    To search only cases updated after a certain date, use update_time restricted with that particular date, time, and timezone in ISO datetime format. For example, update_time>"2020-01-01T00:00:00-05:00". update_time only supports the greater than operator (>).

    Examples:

  • organization="organizations/123456789"

  • project="projects/my-project-id"
  • project="projects/123456789"
  • billing_account="billingAccounts/123456-A0B0C0-CUZ789"
  • organization="organizations/123456789" AND state=CLOSED
  • project="projects/my-project-id" AND creator.email="tester@example.com"
  • project="projects/my-project-id" AND (priority=P0 OR priority=P1)

string query = 1;

Parameter
Name Description
value String

The query to set.
Returns
Type Description
SearchCasesRequest.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public SearchCasesRequest.Builder setQueryBytes(ByteString value)

An expression written in filter language.

A query uses the following fields with the operators equals (=) and AND:

  • organization: An organization name in the form organizations/<organization_id>.
  • project: A project name in the form projects/<project_id>.
  • state: The accepted values are OPEN or CLOSED.
  • priority: The accepted values are P0, P1, P2, P3, or P4. You can specify multiple values for priority using the OR operator. For example, priority=P1 OR priority=P2.
  • creator.email: The email address of the case creator.

  • billingAccount: A billing account in the form billingAccounts/<billing_account_id>

    You must specify either organization or project.

    To search across displayName, description, and comments, use a global restriction with no keyword or operator. For example, "my search".

    To search only cases updated after a certain date, use update_time restricted with that particular date, time, and timezone in ISO datetime format. For example, update_time>"2020-01-01T00:00:00-05:00". update_time only supports the greater than operator (>).

    Examples:

  • organization="organizations/123456789"

  • project="projects/my-project-id"
  • project="projects/123456789"
  • billing_account="billingAccounts/123456-A0B0C0-CUZ789"
  • organization="organizations/123456789" AND state=CLOSED
  • project="projects/my-project-id" AND creator.email="tester@example.com"
  • project="projects/my-project-id" AND (priority=P0 OR priority=P1)

string query = 1;

Parameter
Name Description
value ByteString

The bytes for query to set.
Returns
Type Description
SearchCasesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchCasesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SearchCasesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchCasesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchCasesRequest.Builder
Overrides