Package com.google.cloud.aiplatform.v1

Class ExportTensorboardTimeSeriesDataRequest.Builder

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExportTensorboardTimeSeriesDataRequest.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.GeneratedMessageV3.Builder<ExportTensorboardTimeSeriesDataRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • getTensorboardTimeSeries

        public String getTensorboardTimeSeries()
         Required. The resource name of the TensorboardTimeSeries to export data
 from. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
        string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getTensorboardTimeSeries in interface ExportTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The tensorboardTimeSeries.

      • getTensorboardTimeSeriesBytes

        public com.google.protobuf.ByteString getTensorboardTimeSeriesBytes()
         Required. The resource name of the TensorboardTimeSeries to export data
 from. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
        string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getTensorboardTimeSeriesBytes in interface ExportTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The bytes for tensorboardTimeSeries.

      • setTensorboardTimeSeries

        public ExportTensorboardTimeSeriesDataRequest.Builder setTensorboardTimeSeries​(String value)
         Required. The resource name of the TensorboardTimeSeries to export data
 from. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
        string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The tensorboardTimeSeries to set.
        Returns:
        This builder for chaining.

      • clearTensorboardTimeSeries

        public ExportTensorboardTimeSeriesDataRequest.Builder clearTensorboardTimeSeries()
         Required. The resource name of the TensorboardTimeSeries to export data
 from. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
        string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setTensorboardTimeSeriesBytes

        public ExportTensorboardTimeSeriesDataRequest.Builder setTensorboardTimeSeriesBytes​(com.google.protobuf.ByteString value)
         Required. The resource name of the TensorboardTimeSeries to export data
 from. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
        string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for tensorboardTimeSeries to set.
        Returns:
        This builder for chaining.

      • setFilter

        public ExportTensorboardTimeSeriesDataRequest.Builder setFilter​(String value)
         Exports the TensorboardTimeSeries' data that match the filter expression.
        string filter = 2;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • setFilterBytes

        public ExportTensorboardTimeSeriesDataRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         Exports the TensorboardTimeSeries' data that match the filter expression.
        string filter = 2;
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • getPageSize

        public int getPageSize()
         The maximum number of data points to return per page.
 The default page_size is 1000. Values must be between 1 and 10000.
 Values above 10000 are coerced to 10000.
        int32 page_size = 3;
        Specified by:
        getPageSize in interface ExportTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The pageSize.

      • setPageSize

        public ExportTensorboardTimeSeriesDataRequest.Builder setPageSize​(int value)
         The maximum number of data points to return per page.
 The default page_size is 1000. Values must be between 1 and 10000.
 Values above 10000 are coerced to 10000.
        int32 page_size = 3;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public ExportTensorboardTimeSeriesDataRequest.Builder clearPageSize()
         The maximum number of data points to return per page.
 The default page_size is 1000. Values must be between 1 and 10000.
 Values above 10000 are coerced to 10000.
        int32 page_size = 3;
        Returns:
        This builder for chaining.

      • getPageToken

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

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

      • getPageTokenBytes

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

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

      • setPageToken

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

 When paginating, all other parameters provided to
 [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]
 must match the call that provided the page token.
        string page_token = 4;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

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

 When paginating, all other parameters provided to
 [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]
 must match the call that provided the page token.
        string page_token = 4;
        Returns:
        This builder for chaining.

      • setPageTokenBytes

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

 When paginating, all other parameters provided to
 [ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]
 must match the call that provided the page token.
        string page_token = 4;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • getOrderByBytes

        public com.google.protobuf.ByteString getOrderByBytes()
         Field to use to sort the TensorboardTimeSeries' data.
 By default, TensorboardTimeSeries' data is returned in a pseudo random
 order.
        string order_by = 5;
        Specified by:
        getOrderByBytes in interface ExportTensorboardTimeSeriesDataRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • setOrderBy

        public ExportTensorboardTimeSeriesDataRequest.Builder setOrderBy​(String value)
         Field to use to sort the TensorboardTimeSeries' data.
 By default, TensorboardTimeSeries' data is returned in a pseudo random
 order.
        string order_by = 5;
        Parameters:
        value - The orderBy to set.
        Returns:
        This builder for chaining.

      • clearOrderBy

        public ExportTensorboardTimeSeriesDataRequest.Builder clearOrderBy()
         Field to use to sort the TensorboardTimeSeries' data.
 By default, TensorboardTimeSeries' data is returned in a pseudo random
 order.
        string order_by = 5;
        Returns:
        This builder for chaining.

      • setOrderByBytes

        public ExportTensorboardTimeSeriesDataRequest.Builder setOrderByBytes​(com.google.protobuf.ByteString value)
         Field to use to sort the TensorboardTimeSeries' data.
 By default, TensorboardTimeSeries' data is returned in a pseudo random
 order.
        string order_by = 5;
        Parameters:
        value - The bytes for orderBy to set.
        Returns:
        This builder for chaining.