Package com.google.cloud.aiplatform.v1

Class ListArtifactsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListArtifactsRequest.Builder>
com.google.cloud.aiplatform.v1.ListArtifactsRequest.Builder
All Implemented Interfaces:
ListArtifactsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListArtifactsRequest
public static final class ListArtifactsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListArtifactsRequest.Builder> implements ListArtifactsRequestOrBuilder
 Request message for
 [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts].
Protobuf type google.cloud.aiplatform.v1.ListArtifactsRequest

  • 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<ListArtifactsRequest.Builder>

    • clear

      public ListArtifactsRequest.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<ListArtifactsRequest.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<ListArtifactsRequest.Builder>

    • getDefaultInstanceForType

      public ListArtifactsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • mergeFrom

      public ListArtifactsRequest.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<ListArtifactsRequest.Builder>

    • mergeFrom

      public ListArtifactsRequest.Builder mergeFrom(ListArtifactsRequest other)

    • isInitialized

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

    • mergeFrom

      public ListArtifactsRequest.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<ListArtifactsRequest.Builder>
      Throws:
      IOException

    • getParent

      public String getParent()
       Required. The MetadataStore whose Artifacts should be listed.
 Format:
 `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListArtifactsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The MetadataStore whose Artifacts should be listed.
 Format:
 `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListArtifactsRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public ListArtifactsRequest.Builder setParent(String value)
       Required. The MetadataStore whose Artifacts should be listed.
 Format:
 `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
      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 ListArtifactsRequest.Builder clearParent()
       Required. The MetadataStore whose Artifacts should be listed.
 Format:
 `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      public ListArtifactsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. The MetadataStore whose Artifacts should be listed.
 Format:
 `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
      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.

    • getPageSize

      public int getPageSize()
       The maximum number of Artifacts to return. The service may return fewer.
 Must be in range 1-1000, inclusive. Defaults to 100.
      int32 page_size = 2;
      Specified by:
      getPageSize in interface ListArtifactsRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public ListArtifactsRequest.Builder setPageSize(int value)
       The maximum number of Artifacts to return. The service may return fewer.
 Must be in range 1-1000, inclusive. Defaults to 100.
      int32 page_size = 2;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListArtifactsRequest.Builder clearPageSize()
       The maximum number of Artifacts to return. The service may return fewer.
 Must be in range 1-1000, inclusive. Defaults to 100.
      int32 page_size = 2;
      Returns:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       A page token, received from a previous
 [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other provided parameters must match the call that
 provided the page token. (Otherwise the request will fail with
 INVALID_ARGUMENT error.)
      string page_token = 3;
      Specified by:
      getPageToken in interface ListArtifactsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       A page token, received from a previous
 [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other provided parameters must match the call that
 provided the page token. (Otherwise the request will fail with
 INVALID_ARGUMENT error.)
      string page_token = 3;
      Specified by:
      getPageTokenBytes in interface ListArtifactsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListArtifactsRequest.Builder setPageToken(String value)
       A page token, received from a previous
 [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other provided parameters must match the call that
 provided the page token. (Otherwise the request will fail with
 INVALID_ARGUMENT error.)
      string page_token = 3;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListArtifactsRequest.Builder clearPageToken()
       A page token, received from a previous
 [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other provided parameters must match the call that
 provided the page token. (Otherwise the request will fail with
 INVALID_ARGUMENT error.)
      string page_token = 3;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListArtifactsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       A page token, received from a previous
 [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other provided parameters must match the call that
 provided the page token. (Otherwise the request will fail with
 INVALID_ARGUMENT error.)
      string page_token = 3;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getFilter

      public String getFilter()
       Filter specifying the boolean condition for the Artifacts to satisfy in
 order to be part of the result set.
 The syntax to define filter query is based on https://google.aip.dev/160.
 The supported set of filters include the following:

 *   **Attribute filtering**:
 For example: `display_name = "test"`.
 Supported fields include: `name`, `display_name`, `uri`, `state`,
 `schema_title`, `create_time`, and `update_time`.
 Time fields, such as `create_time` and `update_time`, require values
 specified in RFC-3339 format.
 For example: `create_time = "2020-11-19T11:30:00-04:00"`
 *   **Metadata field**:
 To filter on metadata fields use traversal operation as follows:
 `metadata.<field_name>.<type_value>`.
 For example: `metadata.field_1.number_value = 10.0`
 In case the field name contains special characters (such as colon), one
 can embed it inside double quote.
 For example: `metadata."field:1".number_value = 10.0`
 *   **Context based filtering**:
 To filter Artifacts based on the contexts to which they belong, use the
 function operator with the full resource name
 `in_context(<context-name>)`.
 For example:
 `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`

 Each of the above supported filter types can be combined together using
 logical operators (`AND` & `OR`). Maximum nested expression depth allowed
 is 5.

 For example: `display_name = "test" AND metadata.field1.bool_value = true`.
      string filter = 4;
      Specified by:
      getFilter in interface ListArtifactsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Filter specifying the boolean condition for the Artifacts to satisfy in
 order to be part of the result set.
 The syntax to define filter query is based on https://google.aip.dev/160.
 The supported set of filters include the following:

 *   **Attribute filtering**:
 For example: `display_name = "test"`.
 Supported fields include: `name`, `display_name`, `uri`, `state`,
 `schema_title`, `create_time`, and `update_time`.
 Time fields, such as `create_time` and `update_time`, require values
 specified in RFC-3339 format.
 For example: `create_time = "2020-11-19T11:30:00-04:00"`
 *   **Metadata field**:
 To filter on metadata fields use traversal operation as follows:
 `metadata.<field_name>.<type_value>`.
 For example: `metadata.field_1.number_value = 10.0`
 In case the field name contains special characters (such as colon), one
 can embed it inside double quote.
 For example: `metadata."field:1".number_value = 10.0`
 *   **Context based filtering**:
 To filter Artifacts based on the contexts to which they belong, use the
 function operator with the full resource name
 `in_context(<context-name>)`.
 For example:
 `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`

 Each of the above supported filter types can be combined together using
 logical operators (`AND` & `OR`). Maximum nested expression depth allowed
 is 5.

 For example: `display_name = "test" AND metadata.field1.bool_value = true`.
      string filter = 4;
      Specified by:
      getFilterBytes in interface ListArtifactsRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public ListArtifactsRequest.Builder setFilter(String value)
       Filter specifying the boolean condition for the Artifacts to satisfy in
 order to be part of the result set.
 The syntax to define filter query is based on https://google.aip.dev/160.
 The supported set of filters include the following:

 *   **Attribute filtering**:
 For example: `display_name = "test"`.
 Supported fields include: `name`, `display_name`, `uri`, `state`,
 `schema_title`, `create_time`, and `update_time`.
 Time fields, such as `create_time` and `update_time`, require values
 specified in RFC-3339 format.
 For example: `create_time = "2020-11-19T11:30:00-04:00"`
 *   **Metadata field**:
 To filter on metadata fields use traversal operation as follows:
 `metadata.<field_name>.<type_value>`.
 For example: `metadata.field_1.number_value = 10.0`
 In case the field name contains special characters (such as colon), one
 can embed it inside double quote.
 For example: `metadata."field:1".number_value = 10.0`
 *   **Context based filtering**:
 To filter Artifacts based on the contexts to which they belong, use the
 function operator with the full resource name
 `in_context(<context-name>)`.
 For example:
 `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`

 Each of the above supported filter types can be combined together using
 logical operators (`AND` & `OR`). Maximum nested expression depth allowed
 is 5.

 For example: `display_name = "test" AND metadata.field1.bool_value = true`.
      string filter = 4;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ListArtifactsRequest.Builder clearFilter()
       Filter specifying the boolean condition for the Artifacts to satisfy in
 order to be part of the result set.
 The syntax to define filter query is based on https://google.aip.dev/160.
 The supported set of filters include the following:

 *   **Attribute filtering**:
 For example: `display_name = "test"`.
 Supported fields include: `name`, `display_name`, `uri`, `state`,
 `schema_title`, `create_time`, and `update_time`.
 Time fields, such as `create_time` and `update_time`, require values
 specified in RFC-3339 format.
 For example: `create_time = "2020-11-19T11:30:00-04:00"`
 *   **Metadata field**:
 To filter on metadata fields use traversal operation as follows:
 `metadata.<field_name>.<type_value>`.
 For example: `metadata.field_1.number_value = 10.0`
 In case the field name contains special characters (such as colon), one
 can embed it inside double quote.
 For example: `metadata."field:1".number_value = 10.0`
 *   **Context based filtering**:
 To filter Artifacts based on the contexts to which they belong, use the
 function operator with the full resource name
 `in_context(<context-name>)`.
 For example:
 `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`

 Each of the above supported filter types can be combined together using
 logical operators (`AND` & `OR`). Maximum nested expression depth allowed
 is 5.

 For example: `display_name = "test" AND metadata.field1.bool_value = true`.
      string filter = 4;
      Returns:
      This builder for chaining.

    • setFilterBytes

      public ListArtifactsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       Filter specifying the boolean condition for the Artifacts to satisfy in
 order to be part of the result set.
 The syntax to define filter query is based on https://google.aip.dev/160.
 The supported set of filters include the following:

 *   **Attribute filtering**:
 For example: `display_name = "test"`.
 Supported fields include: `name`, `display_name`, `uri`, `state`,
 `schema_title`, `create_time`, and `update_time`.
 Time fields, such as `create_time` and `update_time`, require values
 specified in RFC-3339 format.
 For example: `create_time = "2020-11-19T11:30:00-04:00"`
 *   **Metadata field**:
 To filter on metadata fields use traversal operation as follows:
 `metadata.<field_name>.<type_value>`.
 For example: `metadata.field_1.number_value = 10.0`
 In case the field name contains special characters (such as colon), one
 can embed it inside double quote.
 For example: `metadata."field:1".number_value = 10.0`
 *   **Context based filtering**:
 To filter Artifacts based on the contexts to which they belong, use the
 function operator with the full resource name
 `in_context(<context-name>)`.
 For example:
 `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`

 Each of the above supported filter types can be combined together using
 logical operators (`AND` & `OR`). Maximum nested expression depth allowed
 is 5.

 For example: `display_name = "test" AND metadata.field1.bool_value = true`.
      string filter = 4;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getOrderBy

      public String getOrderBy()
       How the list of messages is ordered. Specify the values to order by and an
 ordering operation. The default sorting order is ascending. To specify
 descending order for a field, users append a " desc" suffix; for example:
 "foo desc, bar".
 Subfields are specified with a `.` character, such as foo.bar.
 see https://google.aip.dev/132#ordering for more details.
      string order_by = 5;
      Specified by:
      getOrderBy in interface ListArtifactsRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public com.google.protobuf.ByteString getOrderByBytes()
       How the list of messages is ordered. Specify the values to order by and an
 ordering operation. The default sorting order is ascending. To specify
 descending order for a field, users append a " desc" suffix; for example:
 "foo desc, bar".
 Subfields are specified with a `.` character, such as foo.bar.
 see https://google.aip.dev/132#ordering for more details.
      string order_by = 5;
      Specified by:
      getOrderByBytes in interface ListArtifactsRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • setOrderBy

      public ListArtifactsRequest.Builder setOrderBy(String value)
       How the list of messages is ordered. Specify the values to order by and an
 ordering operation. The default sorting order is ascending. To specify
 descending order for a field, users append a " desc" suffix; for example:
 "foo desc, bar".
 Subfields are specified with a `.` character, such as foo.bar.
 see https://google.aip.dev/132#ordering for more details.
      string order_by = 5;
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • clearOrderBy

      public ListArtifactsRequest.Builder clearOrderBy()
       How the list of messages is ordered. Specify the values to order by and an
 ordering operation. The default sorting order is ascending. To specify
 descending order for a field, users append a " desc" suffix; for example:
 "foo desc, bar".
 Subfields are specified with a `.` character, such as foo.bar.
 see https://google.aip.dev/132#ordering for more details.
      string order_by = 5;
      Returns:
      This builder for chaining.

    • setOrderByBytes

      public ListArtifactsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
       How the list of messages is ordered. Specify the values to order by and an
 ordering operation. The default sorting order is ascending. To specify
 descending order for a field, users append a " desc" suffix; for example:
 "foo desc, bar".
 Subfields are specified with a `.` character, such as foo.bar.
 see https://google.aip.dev/132#ordering for more details.
      string order_by = 5;
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.