Class ListCasesRequest.Builder (0.48.0)

public static final class ListCasesRequest.Builder extends GeneratedMessageV3.Builder<ListCasesRequest.Builder> implements ListCasesRequestOrBuilder

The request message for the ListCases endpoint.

Protobuf type google.cloud.support.v2beta.ListCasesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListCasesRequest build()
Returns
Type Description
ListCasesRequest

buildPartial()

public ListCasesRequest buildPartial()
Returns
Type Description
ListCasesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListCasesRequest.Builder clearFilter()

An expression used to filter cases.

If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter.

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.

    EXAMPLES:

  • state=CLOSED

  • state=OPEN AND creator.email="tester@example.com"
  • state=OPEN AND (priority=P0 OR priority=P1)

string filter = 2;

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListCasesRequest.Builder clearPageSize()

The maximum number of cases fetched with each request. Defaults to 10.

int32 page_size = 4;

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

clearPageToken()

public ListCasesRequest.Builder clearPageToken()

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

string page_token = 5;

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

clearParent()

public ListCasesRequest.Builder clearParent()

Required. The name of a parent to list cases under.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

clearProductLine()

public ListCasesRequest.Builder clearProductLine()

The product line to request cases for. If unspecified, only Google Cloud cases will be returned.

optional .google.cloud.support.v2beta.ProductLine product_line = 8;

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListCasesRequest getDefaultInstanceForType()
Returns
Type Description
ListCasesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

An expression used to filter cases.

If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter.

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.

    EXAMPLES:

  • state=CLOSED

  • state=OPEN AND creator.email="tester@example.com"
  • state=OPEN AND (priority=P0 OR priority=P1)

string filter = 2;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

An expression used to filter cases.

If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter.

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.

    EXAMPLES:

  • state=CLOSED

  • state=OPEN AND creator.email="tester@example.com"
  • state=OPEN AND (priority=P0 OR priority=P1)

string filter = 2;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The maximum number of cases fetched with each request. Defaults to 10.

int32 page_size = 4;

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 = 5;

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 = 5;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The name of a parent to list cases under.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The name of a parent to list cases under.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getProductLine()

public ProductLine getProductLine()

The product line to request cases for. If unspecified, only Google Cloud cases will be returned.

optional .google.cloud.support.v2beta.ProductLine product_line = 8;

Returns
Type Description
ProductLine

The productLine.

getProductLineValue()

public int getProductLineValue()

The product line to request cases for. If unspecified, only Google Cloud cases will be returned.

optional .google.cloud.support.v2beta.ProductLine product_line = 8;

Returns
Type Description
int

The enum numeric value on the wire for productLine.

hasProductLine()

public boolean hasProductLine()

The product line to request cases for. If unspecified, only Google Cloud cases will be returned.

optional .google.cloud.support.v2beta.ProductLine product_line = 8;

Returns
Type Description
boolean

Whether the productLine field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListCasesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListCasesRequest.Builder setFilter(String value)

An expression used to filter cases.

If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter.

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.

    EXAMPLES:

  • state=CLOSED

  • state=OPEN AND creator.email="tester@example.com"
  • state=OPEN AND (priority=P0 OR priority=P1)

string filter = 2;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListCasesRequest.Builder setFilterBytes(ByteString value)

An expression used to filter cases.

If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter.

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.

    EXAMPLES:

  • state=CLOSED

  • state=OPEN AND creator.email="tester@example.com"
  • state=OPEN AND (priority=P0 OR priority=P1)

string filter = 2;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListCasesRequest.Builder setPageSize(int value)

The maximum number of cases fetched with each request. Defaults to 10.

int32 page_size = 4;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListCasesRequest.Builder setPageToken(String value)

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

string page_token = 5;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListCasesRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 5;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

setParent(String value)

public ListCasesRequest.Builder setParent(String value)

Required. The name of a parent to list cases under.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListCasesRequest.Builder setParentBytes(ByteString value)

Required. The name of a parent to list cases under.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

setProductLine(ProductLine value)

public ListCasesRequest.Builder setProductLine(ProductLine value)

The product line to request cases for. If unspecified, only Google Cloud cases will be returned.

optional .google.cloud.support.v2beta.ProductLine product_line = 8;

Parameter
Name Description
value ProductLine

The productLine to set.

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

setProductLineValue(int value)

public ListCasesRequest.Builder setProductLineValue(int value)

The product line to request cases for. If unspecified, only Google Cloud cases will be returned.

optional .google.cloud.support.v2beta.ProductLine product_line = 8;

Parameter
Name Description
value int

The enum numeric value on the wire for productLine to set.

Returns
Type Description
ListCasesRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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