Package com.google.cloud.aiplatform.v1

Interface ListTensorboardRunsRequestOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      Lists the TensorboardRuns that match the filter expression.
      com.google.protobuf.ByteString getFilterBytes()
      Lists the TensorboardRuns that match the filter expression.
      String getOrderBy()
      Field to use to sort the list.
      com.google.protobuf.ByteString getOrderByBytes()
      Field to use to sort the list.
      int getPageSize()
      The maximum number of TensorboardRuns to return.
      String getPageToken()
      A page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call.
      com.google.protobuf.ByteString getPageTokenBytes()
      A page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      com.google.protobuf.FieldMask getReadMask()
      Mask specifying which fields to read.
      com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
      Mask specifying which fields to read.
      boolean hasReadMask()
      Mask specifying which fields to read.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        String getParent()
         Required. The resource name of the TensorboardExperiment to list
 TensorboardRuns. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the TensorboardExperiment to list
 TensorboardRuns. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.

      • getFilter

        String getFilter()
         Lists the TensorboardRuns that match the filter expression.
        string filter = 2;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         Lists the TensorboardRuns that match the filter expression.
        string filter = 2;
        Returns:
        The bytes for filter.

      • getPageSize

        int getPageSize()
         The maximum number of TensorboardRuns to return. The service may return
 fewer than this value. If unspecified, at most 50 TensorboardRuns are
 returned. The maximum value is 1000; values above 1000 are coerced to
 1000.
        int32 page_size = 3;
        Returns:
        The pageSize.

      • getPageToken

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

 When paginating, all other parameters provided to
 [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
 must match the call that provided the page token.
        string page_token = 4;
        Returns:
        The pageToken.

      • getPageTokenBytes

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

 When paginating, all other parameters provided to
 [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
 must match the call that provided the page token.
        string page_token = 4;
        Returns:
        The bytes for pageToken.

      • getOrderBy

        String getOrderBy()
         Field to use to sort the list.
        string order_by = 5;
        Returns:
        The orderBy.

      • getOrderByBytes

        com.google.protobuf.ByteString getOrderByBytes()
         Field to use to sort the list.
        string order_by = 5;
        Returns:
        The bytes for orderBy.

      • hasReadMask

        boolean hasReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 6;
        Returns:
        Whether the readMask field is set.

      • getReadMask

        com.google.protobuf.FieldMask getReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 6;
        Returns:
        The readMask.

      • getReadMaskOrBuilder

        com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 6;