Class ListOccurrencesRequest.Builder (2.84.0)

public static final class ListOccurrencesRequest.Builder extends GeneratedMessage.Builder<ListOccurrencesRequest.Builder> implements ListOccurrencesRequestOrBuilder

Request to list occurrences.

Protobuf type grafeas.v1.ListOccurrencesRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListOccurrencesRequest build()
Returns
Type Description
ListOccurrencesRequest

buildPartial()

public ListOccurrencesRequest buildPartial()
Returns
Type Description
ListOccurrencesRequest

clear()

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

clearFilter()

public ListOccurrencesRequest.Builder clearFilter()

The filter expression.

string filter = 2;

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.

clearPageSize()

public ListOccurrencesRequest.Builder clearPageSize()

Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.

int32 page_size = 3;

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.

clearPageToken()

public ListOccurrencesRequest.Builder clearPageToken()

Token to provide to skip to a particular spot in the list.

string page_token = 4;

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.

clearParent()

public ListOccurrencesRequest.Builder clearParent()

The name of the project to list occurrences for in the form of projects/[PROJECT_ID].

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

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.

clearReturnPartialSuccess()

public ListOccurrencesRequest.Builder clearReturnPartialSuccess()

If set, the request will return all reachable Occurrences and report all unreachable regions in the unreachable field in the response.

Only applicable for requests in the global region.

bool return_partial_success = 5;

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListOccurrencesRequest getDefaultInstanceForType()
Returns
Type Description
ListOccurrencesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

The filter expression.

string filter = 2;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter expression.

string filter = 2;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.

int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Token to provide to skip to a particular spot in the list.

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Token to provide to skip to a particular spot in the list.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

The name of the project to list occurrences for in the form of projects/[PROJECT_ID].

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

The name of the project to list occurrences for in the form of projects/[PROJECT_ID].

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

Returns
Type Description
ByteString

The bytes for parent.

getReturnPartialSuccess()

public boolean getReturnPartialSuccess()

If set, the request will return all reachable Occurrences and report all unreachable regions in the unreachable field in the response.

Only applicable for requests in the global region.

bool return_partial_success = 5;

Returns
Type Description
boolean

The returnPartialSuccess.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(ListOccurrencesRequest other)

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

setFilter(String value)

public ListOccurrencesRequest.Builder setFilter(String value)

The filter expression.

string filter = 2;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListOccurrencesRequest.Builder setFilterBytes(ByteString value)

The filter expression.

string filter = 2;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListOccurrencesRequest.Builder setPageSize(int value)

Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.

int32 page_size = 3;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListOccurrencesRequest.Builder setPageToken(String value)

Token to provide to skip to a particular spot in the list.

string page_token = 4;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListOccurrencesRequest.Builder setPageTokenBytes(ByteString value)

Token to provide to skip to a particular spot in the list.

string page_token = 4;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.

setParent(String value)

public ListOccurrencesRequest.Builder setParent(String value)

The name of the project to list occurrences for in the form of projects/[PROJECT_ID].

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListOccurrencesRequest.Builder setParentBytes(ByteString value)

The name of the project to list occurrences for in the form of projects/[PROJECT_ID].

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
ListOccurrencesRequest.Builder

This builder for chaining.

setReturnPartialSuccess(boolean value)

public ListOccurrencesRequest.Builder setReturnPartialSuccess(boolean value)

If set, the request will return all reachable Occurrences and report all unreachable regions in the unreachable field in the response.

Only applicable for requests in the global region.

bool return_partial_success = 5;

Parameter
Name Description
value boolean

The returnPartialSuccess to set.

Returns
Type Description
ListOccurrencesRequest.Builder

This builder for chaining.