Class ListAnnotationsRequest.Builder (3.44.0)

public static final class ListAnnotationsRequest.Builder extends GeneratedMessageV3.Builder<ListAnnotationsRequest.Builder> implements ListAnnotationsRequestOrBuilder

Request message for DatasetService.ListAnnotations.

Protobuf type google.cloud.aiplatform.v1beta1.ListAnnotationsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListAnnotationsRequest build()
Returns
Type Description
ListAnnotationsRequest

buildPartial()

public ListAnnotationsRequest buildPartial()
Returns
Type Description
ListAnnotationsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListAnnotationsRequest.Builder clearFilter()

The standard list filter.

string filter = 2;

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListAnnotationsRequest.Builder clearOrderBy()

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

string order_by = 6;

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

clearPageSize()

public ListAnnotationsRequest.Builder clearPageSize()

The standard list page size.

int32 page_size = 3;

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

clearPageToken()

public ListAnnotationsRequest.Builder clearPageToken()

The standard list page token.

string page_token = 4;

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

clearParent()

public ListAnnotationsRequest.Builder clearParent()

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

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

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

clearReadMask()

public ListAnnotationsRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
ListAnnotationsRequest.Builder

clone()

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

getDefaultInstanceForType()

public ListAnnotationsRequest getDefaultInstanceForType()
Returns
Type Description
ListAnnotationsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

The standard list filter.

string filter = 2;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The standard list filter.

string filter = 2;

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

string order_by = 6;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

string order_by = 6;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

The standard list page size.

int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

The standard list page token.

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The standard list page token.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

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

Returns
Type Description
ByteString

The bytes for parent.

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListAnnotationsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeReadMask(FieldMask value)

public ListAnnotationsRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListAnnotationsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListAnnotationsRequest.Builder setFilter(String value)

The standard list filter.

string filter = 2;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListAnnotationsRequest.Builder setFilterBytes(ByteString value)

The standard list filter.

string filter = 2;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListAnnotationsRequest.Builder setOrderBy(String value)

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

string order_by = 6;

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListAnnotationsRequest.Builder setOrderByBytes(ByteString value)

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

string order_by = 6;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListAnnotationsRequest.Builder setPageSize(int value)

The standard list page size.

int32 page_size = 3;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListAnnotationsRequest.Builder setPageToken(String value)

The standard list page token.

string page_token = 4;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListAnnotationsRequest.Builder setPageTokenBytes(ByteString value)

The standard list page token.

string page_token = 4;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

setParent(String value)

public ListAnnotationsRequest.Builder setParent(String value)

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListAnnotationsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListAnnotationsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}

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

This builder for chaining.

setReadMask(FieldMask value)

public ListAnnotationsRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListAnnotationsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListAnnotationsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ListAnnotationsRequest.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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