Class ListSearchHypernymsRequest.Builder (0.12.0)

public static final class ListSearchHypernymsRequest.Builder extends GeneratedMessageV3.Builder<ListSearchHypernymsRequest.Builder> implements ListSearchHypernymsRequestOrBuilder

Request message for listing SearchHypernyms.

Protobuf type google.cloud.visionai.v1.ListSearchHypernymsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListSearchHypernymsRequest build()
Returns
Type Description
ListSearchHypernymsRequest

buildPartial()

public ListSearchHypernymsRequest buildPartial()
Returns
Type Description
ListSearchHypernymsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListSearchHypernymsRequest.Builder clearPageSize()

The maximum number of SearchHypernyms returned. The service may return fewer than this value. If unspecified, a page size of 50 will be used. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Returns
Type Description
ListSearchHypernymsRequest.Builder

This builder for chaining.

clearPageToken()

public ListSearchHypernymsRequest.Builder clearPageToken()

A page token, received from a previous SearchHypernym call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchHypernym must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ListSearchHypernymsRequest.Builder

This builder for chaining.

clearParent()

public ListSearchHypernymsRequest.Builder clearParent()

Required. The parent, which owns this collection of SearchHypernyms. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

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

Returns
Type Description
ListSearchHypernymsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListSearchHypernymsRequest getDefaultInstanceForType()
Returns
Type Description
ListSearchHypernymsRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

The maximum number of SearchHypernyms returned. The service may return fewer than this value. If unspecified, a page size of 50 will be used. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous SearchHypernym call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchHypernym must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous SearchHypernym call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchHypernym must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent, which owns this collection of SearchHypernyms. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent, which owns this collection of SearchHypernyms. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListSearchHypernymsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public ListSearchHypernymsRequest.Builder setPageSize(int value)

The maximum number of SearchHypernyms returned. The service may return fewer than this value. If unspecified, a page size of 50 will be used. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListSearchHypernymsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListSearchHypernymsRequest.Builder setPageToken(String value)

A page token, received from a previous SearchHypernym call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchHypernym must match the call that provided the page token.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListSearchHypernymsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListSearchHypernymsRequest.Builder setPageTokenBytes(ByteString value)

A page token, received from a previous SearchHypernym call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchHypernym must match the call that provided the page token.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListSearchHypernymsRequest.Builder

This builder for chaining.

setParent(String value)

public ListSearchHypernymsRequest.Builder setParent(String value)

Required. The parent, which owns this collection of SearchHypernyms. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListSearchHypernymsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListSearchHypernymsRequest.Builder setParentBytes(ByteString value)

Required. The parent, which owns this collection of SearchHypernyms. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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