public static final class ListStudiesRequest.Builder extends GeneratedMessage.Builder<ListStudiesRequest.Builder> implements ListStudiesRequestOrBuilderRequest message for VizierService.ListStudies.
Protobuf type google.cloud.aiplatform.v1.ListStudiesRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListStudiesRequest.BuilderImplements
ListStudiesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
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. |
getDefaultInstanceForType()
public ListStudiesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListStudiesRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListStudiesRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListStudiesRequest.Builder |
|
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 |
intThe 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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListStudiesRequest.Builder |
This builder for chaining. |