Module org.yamcs.api

Package org.yamcs.protobuf

Class ListItemsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

org.yamcs.protobuf.ListItemsRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ListItemsRequestOrBuilder

@Generated
public final class ListItemsRequest
extends com.google.protobuf.GeneratedMessage
implements ListItemsRequestOrBuilder

Protobuf type yamcs.protobuf.timeline.ListItemsRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ListItemsRequest.Builder	Protobuf type yamcs.protobuf.timeline.ListItemsRequest

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BAND_FIELD_NUMBER
static final int	DETAILS_FIELD_NUMBER
static final int	FILTER_FIELD_NUMBER
static final int	INSTANCE_FIELD_NUMBER
static final int	LIMIT_FIELD_NUMBER
static final int	NEXT_FIELD_NUMBER
static final int	SOURCE_FIELD_NUMBER
static final int	START_FIELD_NUMBER
static final int	STOP_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getBand()	Use the band defined source and filter
com.google.protobuf.ByteString	getBandBytes()	Use the band defined source and filter
static ListItemsRequest	getDefaultInstance()
ListItemsRequest	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getDetails()	If true, send the items with full details If false, some details like the description will be omited from the listed items
String	getFilter()	Filter query.
com.google.protobuf.ByteString	getFilterBytes()	Filter query.
String	getInstance()	Yamcs instance name
com.google.protobuf.ByteString	getInstanceBytes()	Yamcs instance name
int	getLimit()	optional int32 limit = 3;
String	getNext()	Continuation token returned by a previous page response.
com.google.protobuf.ByteString	getNextBytes()	Continuation token returned by a previous page response.
com.google.protobuf.Parser<ListItemsRequest>	getParserForType()
int	getSerializedSize()
String	getSource()	Item source
com.google.protobuf.ByteString	getSourceBytes()	Item source
com.google.protobuf.Timestamp	getStart()	Filter on item start
com.google.protobuf.TimestampOrBuilder	getStartOrBuilder()	Filter on item start
com.google.protobuf.Timestamp	getStop()	Filter on item stop
com.google.protobuf.TimestampOrBuilder	getStopOrBuilder()	Filter on item stop
boolean	hasBand()	Use the band defined source and filter
boolean	hasDetails()	If true, send the items with full details If false, some details like the description will be omited from the listed items
boolean	hasFilter()	Filter query.
int	hashCode()
boolean	hasInstance()	Yamcs instance name
boolean	hasLimit()	optional int32 limit = 3;
boolean	hasNext()	Continuation token returned by a previous page response.
boolean	hasSource()	Item source
boolean	hasStart()	Filter on item start
boolean	hasStop()	Filter on item stop
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static ListItemsRequest.Builder	newBuilder()
static ListItemsRequest.Builder	newBuilder(ListItemsRequest prototype)
ListItemsRequest.Builder	newBuilderForType()
protected ListItemsRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static ListItemsRequest	parseDelimitedFrom(InputStream input)
static ListItemsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListItemsRequest	parseFrom(byte[] data)
static ListItemsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListItemsRequest	parseFrom(com.google.protobuf.ByteString data)
static ListItemsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListItemsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ListItemsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListItemsRequest	parseFrom(InputStream input)
static ListItemsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListItemsRequest	parseFrom(ByteBuffer data)
static ListItemsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ListItemsRequest>	parser()
ListItemsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER

See Also:

• Constant Field Values

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER

See Also:

• Constant Field Values

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER

See Also:

• Constant Field Values

NEXT_FIELD_NUMBER

public static final int NEXT_FIELD_NUMBER

See Also:

• Constant Field Values

START_FIELD_NUMBER

public static final int START_FIELD_NUMBER

See Also:

• Constant Field Values

STOP_FIELD_NUMBER

public static final int STOP_FIELD_NUMBER

See Also:

• Constant Field Values

BAND_FIELD_NUMBER

public static final int BAND_FIELD_NUMBER

See Also:

• Constant Field Values

DETAILS_FIELD_NUMBER

public static final int DETAILS_FIELD_NUMBER

See Also:

• Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

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

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

hasInstance

public boolean hasInstance()

 Yamcs instance name
 

optional string instance = 1;

Specified by:

hasInstance in interface ListItemsRequestOrBuilder

Returns:

Whether the instance field is set.

getInstance

public String getInstance()

 Yamcs instance name
 

optional string instance = 1;

Specified by:

getInstance in interface ListItemsRequestOrBuilder

Returns:

The instance.

getInstanceBytes

public com.google.protobuf.ByteString getInstanceBytes()

 Yamcs instance name
 

optional string instance = 1;

Specified by:

getInstanceBytes in interface ListItemsRequestOrBuilder

Returns:

The bytes for instance.

hasSource

public boolean hasSource()

 Item source
 

optional string source = 2;

Specified by:

hasSource in interface ListItemsRequestOrBuilder

Returns:

Whether the source field is set.

getSource

public String getSource()

 Item source
 

optional string source = 2;

Specified by:

getSource in interface ListItemsRequestOrBuilder

Returns:

The source.

getSourceBytes

public com.google.protobuf.ByteString getSourceBytes()

 Item source
 

optional string source = 2;

Specified by:

getSourceBytes in interface ListItemsRequestOrBuilder

Returns:

The bytes for source.

hasLimit

public boolean hasLimit()

optional int32 limit = 3;

Specified by:

hasLimit in interface ListItemsRequestOrBuilder

Returns:

Whether the limit field is set.

getLimit

public int getLimit()

optional int32 limit = 3;

Specified by:

getLimit in interface ListItemsRequestOrBuilder

Returns:

The limit.

hasNext

public boolean hasNext()

 Continuation token returned by a previous page response.
 

optional string next = 4;

Specified by:

hasNext in interface ListItemsRequestOrBuilder

Returns:

Whether the next field is set.

getNext

public String getNext()

 Continuation token returned by a previous page response.
 

optional string next = 4;

Specified by:

getNext in interface ListItemsRequestOrBuilder

Returns:

The next.

getNextBytes

public com.google.protobuf.ByteString getNextBytes()

 Continuation token returned by a previous page response.
 

optional string next = 4;

Specified by:

getNextBytes in interface ListItemsRequestOrBuilder

Returns:

The bytes for next.

hasStart

public boolean hasStart()

 Filter on item start
 

optional .google.protobuf.Timestamp start = 5;

Specified by:

hasStart in interface ListItemsRequestOrBuilder

Returns:

Whether the start field is set.

getStart

public com.google.protobuf.Timestamp getStart()

 Filter on item start
 

optional .google.protobuf.Timestamp start = 5;

Specified by:

getStart in interface ListItemsRequestOrBuilder

Returns:

The start.

getStartOrBuilder

public com.google.protobuf.TimestampOrBuilder getStartOrBuilder()

 Filter on item start
 

optional .google.protobuf.Timestamp start = 5;

Specified by:

getStartOrBuilder in interface ListItemsRequestOrBuilder

hasStop

public boolean hasStop()

 Filter on item stop
 

optional .google.protobuf.Timestamp stop = 6;

Specified by:

hasStop in interface ListItemsRequestOrBuilder

Returns:

Whether the stop field is set.

getStop

public com.google.protobuf.Timestamp getStop()

 Filter on item stop
 

optional .google.protobuf.Timestamp stop = 6;

Specified by:

getStop in interface ListItemsRequestOrBuilder

Returns:

The stop.

getStopOrBuilder

public com.google.protobuf.TimestampOrBuilder getStopOrBuilder()

 Filter on item stop
 

optional .google.protobuf.Timestamp stop = 6;

Specified by:

getStopOrBuilder in interface ListItemsRequestOrBuilder

hasBand

public boolean hasBand()

 Use the band defined source and filter
 

optional string band = 7;

Specified by:

hasBand in interface ListItemsRequestOrBuilder

Returns:

Whether the band field is set.

getBand

public String getBand()

 Use the band defined source and filter
 

optional string band = 7;

Specified by:

getBand in interface ListItemsRequestOrBuilder

Returns:

The band.

getBandBytes

public com.google.protobuf.ByteString getBandBytes()

 Use the band defined source and filter
 

optional string band = 7;

Specified by:

getBandBytes in interface ListItemsRequestOrBuilder

Returns:

The bytes for band.

hasDetails

public boolean hasDetails()

 If true, send the items with full details
 If false, some details like the description will be omited from the listed items
 

optional bool details = 9;

Specified by:

hasDetails in interface ListItemsRequestOrBuilder

Returns:

Whether the details field is set.

getDetails

public boolean getDetails()

 If true, send the items with full details
 If false, some details like the description will be omited from the listed items
 

optional bool details = 9;

Specified by:

getDetails in interface ListItemsRequestOrBuilder

Returns:

The details.

hasFilter

public boolean hasFilter()

 Filter query. See {doc}`../filtering` for how to write a filter query.

 Literal text search matches against the `label` field. Field comparisons
 can use any of the following fields:

 | Field    | Type   | Description      |
 | -------- | ------ | ---------------- |
 | `label`  | string | Filter by label  |
 | `tag`    | string | Filter by tag    |
 | `type`   | enum   | Filter by type   |
 | `status` | enum   | Filter by status |

 `type` is one of `activity` or `event`.

 `status` is one of `planned`, `ready`, `waiting_on_dependency`,
 `in_progress`, `succeeded`, `aborted`, `failed`, `skipped`, `canceled`,
 `paused` or `waiting_for_input`.
 

optional string filter = 10;

Specified by:

hasFilter in interface ListItemsRequestOrBuilder

Returns:

Whether the filter field is set.

getFilter

public String getFilter()

 Filter query. See {doc}`../filtering` for how to write a filter query.

 Literal text search matches against the `label` field. Field comparisons
 can use any of the following fields:

 | Field    | Type   | Description      |
 | -------- | ------ | ---------------- |
 | `label`  | string | Filter by label  |
 | `tag`    | string | Filter by tag    |
 | `type`   | enum   | Filter by type   |
 | `status` | enum   | Filter by status |

 `type` is one of `activity` or `event`.

 `status` is one of `planned`, `ready`, `waiting_on_dependency`,
 `in_progress`, `succeeded`, `aborted`, `failed`, `skipped`, `canceled`,
 `paused` or `waiting_for_input`.
 

optional string filter = 10;

Specified by:

getFilter in interface ListItemsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Filter query. See {doc}`../filtering` for how to write a filter query.

 Literal text search matches against the `label` field. Field comparisons
 can use any of the following fields:

 | Field    | Type   | Description      |
 | -------- | ------ | ---------------- |
 | `label`  | string | Filter by label  |
 | `tag`    | string | Filter by tag    |
 | `type`   | enum   | Filter by type   |
 | `status` | enum   | Filter by status |

 `type` is one of `activity` or `event`.

 `status` is one of `planned`, `ready`, `waiting_on_dependency`,
 `in_progress`, `succeeded`, `aborted`, `failed`, `skipped`, `canceled`,
 `paused` or `waiting_for_input`.
 

optional string filter = 10;

Specified by:

getFilterBytes in interface ListItemsRequestOrBuilder

Returns:

The bytes for filter.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ListItemsRequest parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListItemsRequest parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListItemsRequest parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListItemsRequest parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListItemsRequest parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListItemsRequest parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListItemsRequest parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static ListItemsRequest parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListItemsRequest parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListItemsRequest parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static ListItemsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static ListItemsRequest parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public ListItemsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ListItemsRequest.Builder newBuilder()

newBuilder

public static ListItemsRequest.Builder newBuilder(ListItemsRequest prototype)

toBuilder

public ListItemsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ListItemsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static ListItemsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ListItemsRequest> parser()

getParserForType

public com.google.protobuf.Parser<ListItemsRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public ListItemsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder