Class ListStudiesRequest.Builder (3.25.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListStudiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListStudiesRequest.Builder
Overrides

build()

public ListStudiesRequest build()
Returns
TypeDescription
ListStudiesRequest

buildPartial()

public ListStudiesRequest buildPartial()
Returns
TypeDescription
ListStudiesRequest

clear()

public ListStudiesRequest.Builder clear()
Returns
TypeDescription
ListStudiesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListStudiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListStudiesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListStudiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListStudiesRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
ListStudiesRequest.Builder

This builder for chaining.

clone()

public ListStudiesRequest.Builder clone()
Returns
TypeDescription
ListStudiesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListStudiesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListStudiesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListStudiesRequest other)

public ListStudiesRequest.Builder mergeFrom(ListStudiesRequest other)
Parameter
NameDescription
otherListStudiesRequest
Returns
TypeDescription
ListStudiesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListStudiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListStudiesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListStudiesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListStudiesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListStudiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListStudiesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListStudiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListStudiesRequest.Builder
Overrides

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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListStudiesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListStudiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListStudiesRequest.Builder
Overrides