public static final class ListStudiesRequest.Builder extends GeneratedMessageV3.Builder<ListStudiesRequest.Builder> implements ListStudiesRequestOrBuilder
Request message for VizierService.ListStudies.
Protobuf type google.cloud.aiplatform.v1.ListStudiesRequest
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
public ListStudiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public ListStudiesRequest build()
Returns
public ListStudiesRequest buildPartial()
Returns
public ListStudiesRequest.Builder clear()
Returns
Overrides
public ListStudiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
public ListStudiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
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];
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];
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) = { ... }
public ListStudiesRequest.Builder clone()
Returns
Overrides
public ListStudiesRequest getDefaultInstanceForType()
Returns
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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];
| 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];
| 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];
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) = { ... }
| Type | Description |
| String | The parent.
|
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) = { ... }
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public ListStudiesRequest.Builder mergeFrom(ListStudiesRequest other)
Parameter
Returns
public ListStudiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
public ListStudiesRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
public final ListStudiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
public ListStudiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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];
| Name | Description |
| value | int
The pageSize to set.
|
Returns
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];
| Name | Description |
| value | String
The pageToken to set.
|
Returns
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];
| Name | Description |
| value | ByteString
The bytes for pageToken to set.
|
Returns
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) = { ... }
| Name | Description |
| value | String
The parent to set.
|
Returns
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) = { ... }
| Name | Description |
| value | ByteString
The bytes for parent to set.
|
Returns
public ListStudiesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
public final ListStudiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
