Class ListStudiesRequest.Builder (3.4.1)

public static final class ListStudiesRequest.Builder extends GeneratedMessageV3.Builder<ListStudiesRequest.Builder> implements ListStudiesRequestOrBuilder

Request message for VizierService.ListStudies.

Protobuf type google.cloud.aiplatform.v1beta1.ListStudiesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListStudiesRequest.Builder

Implements

ListStudiesRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListStudiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
ListStudiesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListStudiesRequest build()

Returns

Type	Description
ListStudiesRequest

buildPartial()

public ListStudiesRequest buildPartial()

Returns

Type	Description
ListStudiesRequest

clear()

public ListStudiesRequest.Builder clear()

Returns

Type	Description
ListStudiesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListStudiesRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
ListStudiesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public ListStudiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
ListStudiesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPageSize()

public ListStudiesRequest.Builder clearPageSize()

Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ListStudiesRequest.Builder	This builder for chaining.

clearPageToken()

public ListStudiesRequest.Builder clearPageToken()

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ListStudiesRequest.Builder	This builder for chaining.

clearParent()

public ListStudiesRequest.Builder clearParent()

Required. The resource name of the Location to list the Study from. Format: projects/{project}/locations/{location}

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

Returns

Type	Description
ListStudiesRequest.Builder	This builder for chaining.

clone()

public ListStudiesRequest.Builder clone()

Returns

Type	Description
ListStudiesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListStudiesRequest getDefaultInstanceForType()

Returns

Type	Description
ListStudiesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getPageSize()

public int getPageSize()

Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int	The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the Location to list the Study from. Format: projects/{project}/locations/{location}

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 Location to list the Study from. Format: projects/{project}/locations/{location}

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ListStudiesRequest other)

public ListStudiesRequest.Builder mergeFrom(ListStudiesRequest other)

Parameter

Name	Description
other	`ListStudiesRequest`

Returns

Type	Description
ListStudiesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListStudiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
ListStudiesRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ListStudiesRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
ListStudiesRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListStudiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
ListStudiesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public ListStudiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
ListStudiesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setPageSize(int value)

public ListStudiesRequest.Builder setPageSize(int value)

Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`int` The pageSize to set.

Returns

Type	Description
ListStudiesRequest.Builder	This builder for chaining.

setPageToken(String value)

public ListStudiesRequest.Builder setPageToken(String value)

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`String` The pageToken to set.

Returns

Type	Description
ListStudiesRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListStudiesRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`ByteString` The bytes for pageToken to set.

Returns

Type	Description
ListStudiesRequest.Builder	This builder for chaining.

setParent(String value)

public ListStudiesRequest.Builder setParent(String value)

Required. The resource name of the Location to list the Study from. Format: projects/{project}/locations/{location}

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

Parameter

Name	Description
value	`String` The parent to set.

Returns

Type	Description
ListStudiesRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public ListStudiesRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the Location to list the Study from. Format: projects/{project}/locations/{location}

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
ListStudiesRequest.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
ListStudiesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListStudiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
ListStudiesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)