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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Methods
public ListStudiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public ListStudiesRequest build()
public ListStudiesRequest buildPartial()
public ListStudiesRequest.Builder clear()
Overrides
public ListStudiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
public ListStudiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
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()
Overrides
public ListStudiesRequest getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
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];
| 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.
|
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.
|
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.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListStudiesRequest.Builder mergeFrom(ListStudiesRequest other)
public ListStudiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public ListStudiesRequest.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
public final ListStudiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
public ListStudiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
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 |
| Name |
Description |
value |
int
The pageSize to set.
|
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.
|
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.
|
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.
|
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.
|
public ListStudiesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
public final ListStudiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
