Class ListNotesRequest.Builder (2.84.0)

public static final class ListNotesRequest.Builder extends GeneratedMessage.Builder<ListNotesRequest.Builder> implements ListNotesRequestOrBuilder

Request to list notes.

Protobuf type grafeas.v1.ListNotesRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListNotesRequest build()
Returns
Type Description
ListNotesRequest

buildPartial()

public ListNotesRequest buildPartial()
Returns
Type Description
ListNotesRequest

clear()

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

clearFilter()

public ListNotesRequest.Builder clearFilter()

The filter expression.

string filter = 2;

Returns
Type Description
ListNotesRequest.Builder

This builder for chaining.

clearPageSize()

public ListNotesRequest.Builder clearPageSize()

Number of notes 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
ListNotesRequest.Builder

This builder for chaining.

clearPageToken()

public ListNotesRequest.Builder clearPageToken()

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

string page_token = 4;

Returns
Type Description
ListNotesRequest.Builder

This builder for chaining.

clearParent()

public ListNotesRequest.Builder clearParent()

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

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

Returns
Type Description
ListNotesRequest.Builder

This builder for chaining.

clearReturnPartialSuccess()

public ListNotesRequest.Builder clearReturnPartialSuccess()

If set, the request will return all reachable Notes 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
ListNotesRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListNotesRequest getDefaultInstanceForType()
Returns
Type Description
ListNotesRequest

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 notes 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 notes 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 notes 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 Notes 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 ListNotesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(ListNotesRequest other)

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

setFilter(String value)

public ListNotesRequest.Builder setFilter(String value)

The filter expression.

string filter = 2;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListNotesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListNotesRequest.Builder setFilterBytes(ByteString value)

The filter expression.

string filter = 2;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListNotesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListNotesRequest.Builder setPageSize(int value)

Number of notes 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
ListNotesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListNotesRequest.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
ListNotesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListNotesRequest.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
ListNotesRequest.Builder

This builder for chaining.

setParent(String value)

public ListNotesRequest.Builder setParent(String value)

The name of the project to list notes 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
ListNotesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListNotesRequest.Builder setParentBytes(ByteString value)

The name of the project to list notes 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
ListNotesRequest.Builder

This builder for chaining.

setReturnPartialSuccess(boolean value)

public ListNotesRequest.Builder setReturnPartialSuccess(boolean value)

If set, the request will return all reachable Notes 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
ListNotesRequest.Builder

This builder for chaining.