com.clarifai.grpc.api.StatValueAggregateQueryOrBuilder Maven / Gradle / Ivy
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: proto/clarifai/api/resources.proto
package com.clarifai.grpc.api;
public interface StatValueAggregateQueryOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.StatValueAggregateQuery)
com.google.protobuf.MessageOrBuilder {
/**
*
* These tags are used to filter down the values before they are aggregated. For example,
* if you want to aggregate values for "task_id:a" you could specify that as a tag here.
*
*
* repeated string tags = 1;
* @return A list containing the tags.
*/
java.util.List
getTagsList();
/**
*
* These tags are used to filter down the values before they are aggregated. For example,
* if you want to aggregate values for "task_id:a" you could specify that as a tag here.
*
*
* repeated string tags = 1;
* @return The count of tags.
*/
int getTagsCount();
/**
*
* These tags are used to filter down the values before they are aggregated. For example,
* if you want to aggregate values for "task_id:a" you could specify that as a tag here.
*
*
* repeated string tags = 1;
* @param index The index of the element to return.
* @return The tags at the given index.
*/
java.lang.String getTags(int index);
/**
*
* These tags are used to filter down the values before they are aggregated. For example,
* if you want to aggregate values for "task_id:a" you could specify that as a tag here.
*
*
* repeated string tags = 1;
* @param index The index of the value to return.
* @return The bytes of the tags at the given index.
*/
com.google.protobuf.ByteString
getTagsBytes(int index);
/**
*
* These are tag groups to aggregate over. So for example if you added stat values with tags
* "task_id:a" and others with "task_id:b", then added ["task_id"] to the task group, it the
* aggregation would return StatValueAggregate values for each task_id. If you provide more than
* one tag_group the response will return all rolled up combinations of them. For example
* ["task_id", "something"] where "something:1" and "something:2" were used as tags for some
* values then you'd get StatValueAggregate values back for:
* task_id | something
* a | 1
* a | 2
* b | 1
* b | 1
*
*
* repeated string tag_groups = 2;
* @return A list containing the tagGroups.
*/
java.util.List
getTagGroupsList();
/**
*
* These are tag groups to aggregate over. So for example if you added stat values with tags
* "task_id:a" and others with "task_id:b", then added ["task_id"] to the task group, it the
* aggregation would return StatValueAggregate values for each task_id. If you provide more than
* one tag_group the response will return all rolled up combinations of them. For example
* ["task_id", "something"] where "something:1" and "something:2" were used as tags for some
* values then you'd get StatValueAggregate values back for:
* task_id | something
* a | 1
* a | 2
* b | 1
* b | 1
*
*
* repeated string tag_groups = 2;
* @return The count of tagGroups.
*/
int getTagGroupsCount();
/**
*
* These are tag groups to aggregate over. So for example if you added stat values with tags
* "task_id:a" and others with "task_id:b", then added ["task_id"] to the task group, it the
* aggregation would return StatValueAggregate values for each task_id. If you provide more than
* one tag_group the response will return all rolled up combinations of them. For example
* ["task_id", "something"] where "something:1" and "something:2" were used as tags for some
* values then you'd get StatValueAggregate values back for:
* task_id | something
* a | 1
* a | 2
* b | 1
* b | 1
*
*
* repeated string tag_groups = 2;
* @param index The index of the element to return.
* @return The tagGroups at the given index.
*/
java.lang.String getTagGroups(int index);
/**
*
* These are tag groups to aggregate over. So for example if you added stat values with tags
* "task_id:a" and others with "task_id:b", then added ["task_id"] to the task group, it the
* aggregation would return StatValueAggregate values for each task_id. If you provide more than
* one tag_group the response will return all rolled up combinations of them. For example
* ["task_id", "something"] where "something:1" and "something:2" were used as tags for some
* values then you'd get StatValueAggregate values back for:
* task_id | something
* a | 1
* a | 2
* b | 1
* b | 1
*
*
* repeated string tag_groups = 2;
* @param index The index of the value to return.
* @return The bytes of the tagGroups at the given index.
*/
com.google.protobuf.ByteString
getTagGroupsBytes(int index);
/**
*
* Aggregation function to use over the values. Count(value) is also always returns.
* Defaults to 'sum' if not provided.
*
*
* .clarifai.api.StatValueAggType stat_value_agg_type = 3;
* @return The enum numeric value on the wire for statValueAggType.
*/
int getStatValueAggTypeValue();
/**
*
* Aggregation function to use over the values. Count(value) is also always returns.
* Defaults to 'sum' if not provided.
*
*
* .clarifai.api.StatValueAggType stat_value_agg_type = 3;
* @return The statValueAggType.
*/
com.clarifai.grpc.api.StatValueAggType getStatValueAggType();
/**
*
* Aggregation bins for time where the values will be aggregated at this bin granualarity.
* And the "time" field will be returned in StatValueAggregate object.
* If not provided then bins are not used, and all time is aggregated over.
*
*
* .clarifai.api.StatTimeAggType stat_time_agg_type = 4;
* @return The enum numeric value on the wire for statTimeAggType.
*/
int getStatTimeAggTypeValue();
/**
*
* Aggregation bins for time where the values will be aggregated at this bin granualarity.
* And the "time" field will be returned in StatValueAggregate object.
* If not provided then bins are not used, and all time is aggregated over.
*
*
* .clarifai.api.StatTimeAggType stat_time_agg_type = 4;
* @return The statTimeAggType.
*/
com.clarifai.grpc.api.StatTimeAggType getStatTimeAggType();
/**
*
* If provided the time range over which values will be >= this time. If not provided then
* all values will be used back to start of time.
*
*
* .google.protobuf.Timestamp start_time = 5;
* @return Whether the startTime field is set.
*/
boolean hasStartTime();
/**
*
* If provided the time range over which values will be >= this time. If not provided then
* all values will be used back to start of time.
*
*
* .google.protobuf.Timestamp start_time = 5;
* @return The startTime.
*/
com.google.protobuf.Timestamp getStartTime();
/**
*
* If provided the time range over which values will be >= this time. If not provided then
* all values will be used back to start of time.
*
*
* .google.protobuf.Timestamp start_time = 5;
*/
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
/**
*
* If provided the time range over which values will be <= this time. If not provided then all
* values will be used up until now().
*
*
* .google.protobuf.Timestamp end_time = 6;
* @return Whether the endTime field is set.
*/
boolean hasEndTime();
/**
*
* If provided the time range over which values will be <= this time. If not provided then all
* values will be used up until now().
*
*
* .google.protobuf.Timestamp end_time = 6;
* @return The endTime.
*/
com.google.protobuf.Timestamp getEndTime();
/**
*
* If provided the time range over which values will be <= this time. If not provided then all
* values will be used up until now().
*
*
* .google.protobuf.Timestamp end_time = 6;
*/
com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder();
}