Class ListStudiesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListStudiesRequest.Builder>
com.google.cloud.aiplatform.v1.ListStudiesRequest.Builder
All Implemented Interfaces:
ListStudiesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListStudiesRequest

public static final class ListStudiesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListStudiesRequest.Builder> implements ListStudiesRequestOrBuilder
 Request message for
 [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies].
 
Protobuf type google.cloud.aiplatform.v1.ListStudiesRequest
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListStudiesRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListStudiesRequest.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListStudiesRequest.Builder>
    • getDefaultInstanceForType

      public ListStudiesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public ListStudiesRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public ListStudiesRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public ListStudiesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListStudiesRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListStudiesRequest.Builder>
    • mergeFrom

      public ListStudiesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListStudiesRequest.Builder>
      Throws:
      IOException
    • 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) = { ... }
      Specified by:
      getParent in interface ListStudiesRequestOrBuilder
      Returns:
      The parent.
    • getParentBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getParentBytes in interface ListStudiesRequestOrBuilder
      Returns:
      The bytes for parent.
    • setParent

      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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      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:
      This builder for chaining.
    • setParentBytes

      public ListStudiesRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.
    • 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];
      Specified by:
      getPageToken in interface ListStudiesRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public com.google.protobuf.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];
      Specified by:
      getPageTokenBytes in interface ListStudiesRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • setPageToken

      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];
      Parameters:
      value - The pageToken to set.
      Returns:
      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:
      This builder for chaining.
    • setPageTokenBytes

      public ListStudiesRequest.Builder setPageTokenBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.
    • 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];
      Specified by:
      getPageSize in interface ListStudiesRequestOrBuilder
      Returns:
      The pageSize.
    • setPageSize

      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];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.