org.finos.tracdap.api.DataReadRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tracdap-api-services Show documentation
Show all versions of tracdap-api-services Show documentation
TRAC D.A.P. platform API, contains service API definitions for the TRAC platform services
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: tracdap/api/data.proto
// Protobuf Java Version: 3.25.3
package org.finos.tracdap.api;
/**
*
**
* Request to read a dataset stored in the TRAC platform.
*
* @see TracDataApi.readDataset
*
*
* Protobuf type {@code tracdap.api.DataReadRequest}
*/
public final class DataReadRequest extends
com.google.protobuf.GeneratedMessageV3 implements
// @@protoc_insertion_point(message_implements:tracdap.api.DataReadRequest)
DataReadRequestOrBuilder {
private static final long serialVersionUID = 0L;
// Use DataReadRequest.newBuilder() to construct.
private DataReadRequest(com.google.protobuf.GeneratedMessageV3.Builder builder) {
super(builder);
}
private DataReadRequest() {
tenant_ = "";
format_ = "";
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(
UnusedPrivateParameter unused) {
return new DataReadRequest();
}
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return org.finos.tracdap.api.Data.internal_static_tracdap_api_DataReadRequest_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return org.finos.tracdap.api.Data.internal_static_tracdap_api_DataReadRequest_fieldAccessorTable
.ensureFieldAccessorsInitialized(
org.finos.tracdap.api.DataReadRequest.class, org.finos.tracdap.api.DataReadRequest.Builder.class);
}
private int bitField0_;
public static final int TENANT_FIELD_NUMBER = 1;
@SuppressWarnings("serial")
private volatile java.lang.Object tenant_ = "";
/**
*
**
* Tenant code for the requested operation, always required.
*
*
* string tenant = 1;
* @return The tenant.
*/
@java.lang.Override
public java.lang.String getTenant() {
java.lang.Object ref = tenant_;
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs =
(com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
tenant_ = s;
return s;
}
}
/**
*
**
* Tenant code for the requested operation, always required.
*
*
* string tenant = 1;
* @return The bytes for tenant.
*/
@java.lang.Override
public com.google.protobuf.ByteString
getTenantBytes() {
java.lang.Object ref = tenant_;
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8(
(java.lang.String) ref);
tenant_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int SELECTOR_FIELD_NUMBER = 2;
private org.finos.tracdap.metadata.TagSelector selector_;
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
* @return Whether the selector field is set.
*/
@java.lang.Override
public boolean hasSelector() {
return ((bitField0_ & 0x00000001) != 0);
}
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
* @return The selector.
*/
@java.lang.Override
public org.finos.tracdap.metadata.TagSelector getSelector() {
return selector_ == null ? org.finos.tracdap.metadata.TagSelector.getDefaultInstance() : selector_;
}
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
*/
@java.lang.Override
public org.finos.tracdap.metadata.TagSelectorOrBuilder getSelectorOrBuilder() {
return selector_ == null ? org.finos.tracdap.metadata.TagSelector.getDefaultInstance() : selector_;
}
public static final int FORMAT_FIELD_NUMBER = 3;
@SuppressWarnings("serial")
private volatile java.lang.Object format_ = "";
/**
*
**
* Format that the dataset will be returned in.
*
* The format must be the mime type of a supported data format.
* Data will be encoded in this format before it is sent back.
*
*
* string format = 3;
* @return The format.
*/
@java.lang.Override
public java.lang.String getFormat() {
java.lang.Object ref = format_;
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs =
(com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
format_ = s;
return s;
}
}
/**
*
**
* Format that the dataset will be returned in.
*
* The format must be the mime type of a supported data format.
* Data will be encoded in this format before it is sent back.
*
*
* string format = 3;
* @return The bytes for format.
*/
@java.lang.Override
public com.google.protobuf.ByteString
getFormatBytes() {
java.lang.Object ref = format_;
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8(
(java.lang.String) ref);
format_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int LIMIT_FIELD_NUMBER = 4;
private long limit_ = 0L;
/**
*
**
* Limit the number of rows returned by the request (optional).
*
* If specified the server will limit the number of rows returned.
* There is a hard limit configured in the back end, TRAC will never return
* more rows than the hard limit regardless of the limit value supplied by
* the client. If no limit value is supplied, the back end hard limit will
* still be applied.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 limit = 4;
* @return Whether the limit field is set.
*/
@java.lang.Override
public boolean hasLimit() {
return ((bitField0_ & 0x00000002) != 0);
}
/**
*
**
* Limit the number of rows returned by the request (optional).
*
* If specified the server will limit the number of rows returned.
* There is a hard limit configured in the back end, TRAC will never return
* more rows than the hard limit regardless of the limit value supplied by
* the client. If no limit value is supplied, the back end hard limit will
* still be applied.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 limit = 4;
* @return The limit.
*/
@java.lang.Override
public long getLimit() {
return limit_;
}
public static final int OFFSET_FIELD_NUMBER = 5;
private long offset_ = 0L;
/**
*
**
* Read dataset starting at the row with the given offset (optional).
*
* If specified the server will start the read operation at the given row offset.
* Can be combined with the limit parameter to achieve pagination.
* If the offset is greater than the size of the dataset, no rows will be returned.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 offset = 5;
* @return Whether the offset field is set.
*/
@java.lang.Override
public boolean hasOffset() {
return ((bitField0_ & 0x00000004) != 0);
}
/**
*
**
* Read dataset starting at the row with the given offset (optional).
*
* If specified the server will start the read operation at the given row offset.
* Can be combined with the limit parameter to achieve pagination.
* If the offset is greater than the size of the dataset, no rows will be returned.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 offset = 5;
* @return The offset.
*/
@java.lang.Override
public long getOffset() {
return offset_;
}
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException {
if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(tenant_)) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 1, tenant_);
}
if (((bitField0_ & 0x00000001) != 0)) {
output.writeMessage(2, getSelector());
}
if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(format_)) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 3, format_);
}
if (((bitField0_ & 0x00000002) != 0)) {
output.writeUInt64(4, limit_);
}
if (((bitField0_ & 0x00000004) != 0)) {
output.writeUInt64(5, offset_);
}
getUnknownFields().writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(tenant_)) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(1, tenant_);
}
if (((bitField0_ & 0x00000001) != 0)) {
size += com.google.protobuf.CodedOutputStream
.computeMessageSize(2, getSelector());
}
if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(format_)) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(3, format_);
}
if (((bitField0_ & 0x00000002) != 0)) {
size += com.google.protobuf.CodedOutputStream
.computeUInt64Size(4, limit_);
}
if (((bitField0_ & 0x00000004) != 0)) {
size += com.google.protobuf.CodedOutputStream
.computeUInt64Size(5, offset_);
}
size += getUnknownFields().getSerializedSize();
memoizedSize = size;
return size;
}
@java.lang.Override
public boolean equals(final java.lang.Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof org.finos.tracdap.api.DataReadRequest)) {
return super.equals(obj);
}
org.finos.tracdap.api.DataReadRequest other = (org.finos.tracdap.api.DataReadRequest) obj;
if (!getTenant()
.equals(other.getTenant())) return false;
if (hasSelector() != other.hasSelector()) return false;
if (hasSelector()) {
if (!getSelector()
.equals(other.getSelector())) return false;
}
if (!getFormat()
.equals(other.getFormat())) return false;
if (hasLimit() != other.hasLimit()) return false;
if (hasLimit()) {
if (getLimit()
!= other.getLimit()) return false;
}
if (hasOffset() != other.hasOffset()) return false;
if (hasOffset()) {
if (getOffset()
!= other.getOffset()) return false;
}
if (!getUnknownFields().equals(other.getUnknownFields())) return false;
return true;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
hash = (37 * hash) + TENANT_FIELD_NUMBER;
hash = (53 * hash) + getTenant().hashCode();
if (hasSelector()) {
hash = (37 * hash) + SELECTOR_FIELD_NUMBER;
hash = (53 * hash) + getSelector().hashCode();
}
hash = (37 * hash) + FORMAT_FIELD_NUMBER;
hash = (53 * hash) + getFormat().hashCode();
if (hasLimit()) {
hash = (37 * hash) + LIMIT_FIELD_NUMBER;
hash = (53 * hash) + com.google.protobuf.Internal.hashLong(
getLimit());
}
if (hasOffset()) {
hash = (37 * hash) + OFFSET_FIELD_NUMBER;
hash = (53 * hash) + com.google.protobuf.Internal.hashLong(
getOffset());
}
hash = (29 * hash) + getUnknownFields().hashCode();
memoizedHashCode = hash;
return hash;
}
public static org.finos.tracdap.api.DataReadRequest parseFrom(
java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static org.finos.tracdap.api.DataReadRequest parseFrom(
java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static org.finos.tracdap.api.DataReadRequest parseFrom(
com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static org.finos.tracdap.api.DataReadRequest parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static org.finos.tracdap.api.DataReadRequest parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static org.finos.tracdap.api.DataReadRequest parseFrom(
byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static org.finos.tracdap.api.DataReadRequest parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static org.finos.tracdap.api.DataReadRequest parseFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
public static org.finos.tracdap.api.DataReadRequest parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input);
}
public static org.finos.tracdap.api.DataReadRequest parseDelimitedFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input, extensionRegistry);
}
public static org.finos.tracdap.api.DataReadRequest parseFrom(
com.google.protobuf.CodedInputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static org.finos.tracdap.api.DataReadRequest parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
@java.lang.Override
public Builder newBuilderForType() { return newBuilder(); }
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(org.finos.tracdap.api.DataReadRequest prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
@java.lang.Override
public Builder toBuilder() {
return this == DEFAULT_INSTANCE
? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
*
**
* Request to read a dataset stored in the TRAC platform.
*
* @see TracDataApi.readDataset
*
*
* Protobuf type {@code tracdap.api.DataReadRequest}
*/
public static final class Builder extends
com.google.protobuf.GeneratedMessageV3.Builder implements
// @@protoc_insertion_point(builder_implements:tracdap.api.DataReadRequest)
org.finos.tracdap.api.DataReadRequestOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return org.finos.tracdap.api.Data.internal_static_tracdap_api_DataReadRequest_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return org.finos.tracdap.api.Data.internal_static_tracdap_api_DataReadRequest_fieldAccessorTable
.ensureFieldAccessorsInitialized(
org.finos.tracdap.api.DataReadRequest.class, org.finos.tracdap.api.DataReadRequest.Builder.class);
}
// Construct using org.finos.tracdap.api.DataReadRequest.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3
.alwaysUseFieldBuilders) {
getSelectorFieldBuilder();
}
}
@java.lang.Override
public Builder clear() {
super.clear();
bitField0_ = 0;
tenant_ = "";
selector_ = null;
if (selectorBuilder_ != null) {
selectorBuilder_.dispose();
selectorBuilder_ = null;
}
format_ = "";
limit_ = 0L;
offset_ = 0L;
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor
getDescriptorForType() {
return org.finos.tracdap.api.Data.internal_static_tracdap_api_DataReadRequest_descriptor;
}
@java.lang.Override
public org.finos.tracdap.api.DataReadRequest getDefaultInstanceForType() {
return org.finos.tracdap.api.DataReadRequest.getDefaultInstance();
}
@java.lang.Override
public org.finos.tracdap.api.DataReadRequest build() {
org.finos.tracdap.api.DataReadRequest result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public org.finos.tracdap.api.DataReadRequest buildPartial() {
org.finos.tracdap.api.DataReadRequest result = new org.finos.tracdap.api.DataReadRequest(this);
if (bitField0_ != 0) { buildPartial0(result); }
onBuilt();
return result;
}
private void buildPartial0(org.finos.tracdap.api.DataReadRequest result) {
int from_bitField0_ = bitField0_;
if (((from_bitField0_ & 0x00000001) != 0)) {
result.tenant_ = tenant_;
}
int to_bitField0_ = 0;
if (((from_bitField0_ & 0x00000002) != 0)) {
result.selector_ = selectorBuilder_ == null
? selector_
: selectorBuilder_.build();
to_bitField0_ |= 0x00000001;
}
if (((from_bitField0_ & 0x00000004) != 0)) {
result.format_ = format_;
}
if (((from_bitField0_ & 0x00000008) != 0)) {
result.limit_ = limit_;
to_bitField0_ |= 0x00000002;
}
if (((from_bitField0_ & 0x00000010) != 0)) {
result.offset_ = offset_;
to_bitField0_ |= 0x00000004;
}
result.bitField0_ |= to_bitField0_;
}
@java.lang.Override
public Builder clone() {
return super.clone();
}
@java.lang.Override
public Builder setField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.setField(field, value);
}
@java.lang.Override
public Builder clearField(
com.google.protobuf.Descriptors.FieldDescriptor field) {
return super.clearField(field);
}
@java.lang.Override
public Builder clearOneof(
com.google.protobuf.Descriptors.OneofDescriptor oneof) {
return super.clearOneof(oneof);
}
@java.lang.Override
public Builder setRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
int index, java.lang.Object value) {
return super.setRepeatedField(field, index, value);
}
@java.lang.Override
public Builder addRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.addRepeatedField(field, value);
}
@java.lang.Override
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof org.finos.tracdap.api.DataReadRequest) {
return mergeFrom((org.finos.tracdap.api.DataReadRequest)other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(org.finos.tracdap.api.DataReadRequest other) {
if (other == org.finos.tracdap.api.DataReadRequest.getDefaultInstance()) return this;
if (!other.getTenant().isEmpty()) {
tenant_ = other.tenant_;
bitField0_ |= 0x00000001;
onChanged();
}
if (other.hasSelector()) {
mergeSelector(other.getSelector());
}
if (!other.getFormat().isEmpty()) {
format_ = other.format_;
bitField0_ |= 0x00000004;
onChanged();
}
if (other.hasLimit()) {
setLimit(other.getLimit());
}
if (other.hasOffset()) {
setOffset(other.getOffset());
}
this.mergeUnknownFields(other.getUnknownFields());
onChanged();
return this;
}
@java.lang.Override
public final boolean isInitialized() {
return true;
}
@java.lang.Override
public Builder mergeFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 10: {
tenant_ = input.readStringRequireUtf8();
bitField0_ |= 0x00000001;
break;
} // case 10
case 18: {
input.readMessage(
getSelectorFieldBuilder().getBuilder(),
extensionRegistry);
bitField0_ |= 0x00000002;
break;
} // case 18
case 26: {
format_ = input.readStringRequireUtf8();
bitField0_ |= 0x00000004;
break;
} // case 26
case 32: {
limit_ = input.readUInt64();
bitField0_ |= 0x00000008;
break;
} // case 32
case 40: {
offset_ = input.readUInt64();
bitField0_ |= 0x00000010;
break;
} // case 40
default: {
if (!super.parseUnknownField(input, extensionRegistry, tag)) {
done = true; // was an endgroup tag
}
break;
} // default:
} // switch (tag)
} // while (!done)
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.unwrapIOException();
} finally {
onChanged();
} // finally
return this;
}
private int bitField0_;
private java.lang.Object tenant_ = "";
/**
*
**
* Tenant code for the requested operation, always required.
*
*
* string tenant = 1;
* @return The tenant.
*/
public java.lang.String getTenant() {
java.lang.Object ref = tenant_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs =
(com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
tenant_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
**
* Tenant code for the requested operation, always required.
*
*
* string tenant = 1;
* @return The bytes for tenant.
*/
public com.google.protobuf.ByteString
getTenantBytes() {
java.lang.Object ref = tenant_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8(
(java.lang.String) ref);
tenant_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
**
* Tenant code for the requested operation, always required.
*
*
* string tenant = 1;
* @param value The tenant to set.
* @return This builder for chaining.
*/
public Builder setTenant(
java.lang.String value) {
if (value == null) { throw new NullPointerException(); }
tenant_ = value;
bitField0_ |= 0x00000001;
onChanged();
return this;
}
/**
*
**
* Tenant code for the requested operation, always required.
*
*
* string tenant = 1;
* @return This builder for chaining.
*/
public Builder clearTenant() {
tenant_ = getDefaultInstance().getTenant();
bitField0_ = (bitField0_ & ~0x00000001);
onChanged();
return this;
}
/**
*
**
* Tenant code for the requested operation, always required.
*
*
* string tenant = 1;
* @param value The bytes for tenant to set.
* @return This builder for chaining.
*/
public Builder setTenantBytes(
com.google.protobuf.ByteString value) {
if (value == null) { throw new NullPointerException(); }
checkByteStringIsUtf8(value);
tenant_ = value;
bitField0_ |= 0x00000001;
onChanged();
return this;
}
private org.finos.tracdap.metadata.TagSelector selector_;
private com.google.protobuf.SingleFieldBuilderV3<
org.finos.tracdap.metadata.TagSelector, org.finos.tracdap.metadata.TagSelector.Builder, org.finos.tracdap.metadata.TagSelectorOrBuilder> selectorBuilder_;
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
* @return Whether the selector field is set.
*/
public boolean hasSelector() {
return ((bitField0_ & 0x00000002) != 0);
}
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
* @return The selector.
*/
public org.finos.tracdap.metadata.TagSelector getSelector() {
if (selectorBuilder_ == null) {
return selector_ == null ? org.finos.tracdap.metadata.TagSelector.getDefaultInstance() : selector_;
} else {
return selectorBuilder_.getMessage();
}
}
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
*/
public Builder setSelector(org.finos.tracdap.metadata.TagSelector value) {
if (selectorBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
selector_ = value;
} else {
selectorBuilder_.setMessage(value);
}
bitField0_ |= 0x00000002;
onChanged();
return this;
}
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
*/
public Builder setSelector(
org.finos.tracdap.metadata.TagSelector.Builder builderForValue) {
if (selectorBuilder_ == null) {
selector_ = builderForValue.build();
} else {
selectorBuilder_.setMessage(builderForValue.build());
}
bitField0_ |= 0x00000002;
onChanged();
return this;
}
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
*/
public Builder mergeSelector(org.finos.tracdap.metadata.TagSelector value) {
if (selectorBuilder_ == null) {
if (((bitField0_ & 0x00000002) != 0) &&
selector_ != null &&
selector_ != org.finos.tracdap.metadata.TagSelector.getDefaultInstance()) {
getSelectorBuilder().mergeFrom(value);
} else {
selector_ = value;
}
} else {
selectorBuilder_.mergeFrom(value);
}
if (selector_ != null) {
bitField0_ |= 0x00000002;
onChanged();
}
return this;
}
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
*/
public Builder clearSelector() {
bitField0_ = (bitField0_ & ~0x00000002);
selector_ = null;
if (selectorBuilder_ != null) {
selectorBuilder_.dispose();
selectorBuilder_ = null;
}
onChanged();
return this;
}
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
*/
public org.finos.tracdap.metadata.TagSelector.Builder getSelectorBuilder() {
bitField0_ |= 0x00000002;
onChanged();
return getSelectorFieldBuilder().getBuilder();
}
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
*/
public org.finos.tracdap.metadata.TagSelectorOrBuilder getSelectorOrBuilder() {
if (selectorBuilder_ != null) {
return selectorBuilder_.getMessageOrBuilder();
} else {
return selector_ == null ?
org.finos.tracdap.metadata.TagSelector.getDefaultInstance() : selector_;
}
}
/**
*
**
* Selector for the dataset being read
*
*
* .tracdap.metadata.TagSelector selector = 2;
*/
private com.google.protobuf.SingleFieldBuilderV3<
org.finos.tracdap.metadata.TagSelector, org.finos.tracdap.metadata.TagSelector.Builder, org.finos.tracdap.metadata.TagSelectorOrBuilder>
getSelectorFieldBuilder() {
if (selectorBuilder_ == null) {
selectorBuilder_ = new com.google.protobuf.SingleFieldBuilderV3<
org.finos.tracdap.metadata.TagSelector, org.finos.tracdap.metadata.TagSelector.Builder, org.finos.tracdap.metadata.TagSelectorOrBuilder>(
getSelector(),
getParentForChildren(),
isClean());
selector_ = null;
}
return selectorBuilder_;
}
private java.lang.Object format_ = "";
/**
*
**
* Format that the dataset will be returned in.
*
* The format must be the mime type of a supported data format.
* Data will be encoded in this format before it is sent back.
*
*
* string format = 3;
* @return The format.
*/
public java.lang.String getFormat() {
java.lang.Object ref = format_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs =
(com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
format_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
**
* Format that the dataset will be returned in.
*
* The format must be the mime type of a supported data format.
* Data will be encoded in this format before it is sent back.
*
*
* string format = 3;
* @return The bytes for format.
*/
public com.google.protobuf.ByteString
getFormatBytes() {
java.lang.Object ref = format_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8(
(java.lang.String) ref);
format_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
**
* Format that the dataset will be returned in.
*
* The format must be the mime type of a supported data format.
* Data will be encoded in this format before it is sent back.
*
*
* string format = 3;
* @param value The format to set.
* @return This builder for chaining.
*/
public Builder setFormat(
java.lang.String value) {
if (value == null) { throw new NullPointerException(); }
format_ = value;
bitField0_ |= 0x00000004;
onChanged();
return this;
}
/**
*
**
* Format that the dataset will be returned in.
*
* The format must be the mime type of a supported data format.
* Data will be encoded in this format before it is sent back.
*
*
* string format = 3;
* @return This builder for chaining.
*/
public Builder clearFormat() {
format_ = getDefaultInstance().getFormat();
bitField0_ = (bitField0_ & ~0x00000004);
onChanged();
return this;
}
/**
*
**
* Format that the dataset will be returned in.
*
* The format must be the mime type of a supported data format.
* Data will be encoded in this format before it is sent back.
*
*
* string format = 3;
* @param value The bytes for format to set.
* @return This builder for chaining.
*/
public Builder setFormatBytes(
com.google.protobuf.ByteString value) {
if (value == null) { throw new NullPointerException(); }
checkByteStringIsUtf8(value);
format_ = value;
bitField0_ |= 0x00000004;
onChanged();
return this;
}
private long limit_ ;
/**
*
**
* Limit the number of rows returned by the request (optional).
*
* If specified the server will limit the number of rows returned.
* There is a hard limit configured in the back end, TRAC will never return
* more rows than the hard limit regardless of the limit value supplied by
* the client. If no limit value is supplied, the back end hard limit will
* still be applied.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 limit = 4;
* @return Whether the limit field is set.
*/
@java.lang.Override
public boolean hasLimit() {
return ((bitField0_ & 0x00000008) != 0);
}
/**
*
**
* Limit the number of rows returned by the request (optional).
*
* If specified the server will limit the number of rows returned.
* There is a hard limit configured in the back end, TRAC will never return
* more rows than the hard limit regardless of the limit value supplied by
* the client. If no limit value is supplied, the back end hard limit will
* still be applied.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 limit = 4;
* @return The limit.
*/
@java.lang.Override
public long getLimit() {
return limit_;
}
/**
*
**
* Limit the number of rows returned by the request (optional).
*
* If specified the server will limit the number of rows returned.
* There is a hard limit configured in the back end, TRAC will never return
* more rows than the hard limit regardless of the limit value supplied by
* the client. If no limit value is supplied, the back end hard limit will
* still be applied.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 limit = 4;
* @param value The limit to set.
* @return This builder for chaining.
*/
public Builder setLimit(long value) {
limit_ = value;
bitField0_ |= 0x00000008;
onChanged();
return this;
}
/**
*
**
* Limit the number of rows returned by the request (optional).
*
* If specified the server will limit the number of rows returned.
* There is a hard limit configured in the back end, TRAC will never return
* more rows than the hard limit regardless of the limit value supplied by
* the client. If no limit value is supplied, the back end hard limit will
* still be applied.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 limit = 4;
* @return This builder for chaining.
*/
public Builder clearLimit() {
bitField0_ = (bitField0_ & ~0x00000008);
limit_ = 0L;
onChanged();
return this;
}
private long offset_ ;
/**
*
**
* Read dataset starting at the row with the given offset (optional).
*
* If specified the server will start the read operation at the given row offset.
* Can be combined with the limit parameter to achieve pagination.
* If the offset is greater than the size of the dataset, no rows will be returned.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 offset = 5;
* @return Whether the offset field is set.
*/
@java.lang.Override
public boolean hasOffset() {
return ((bitField0_ & 0x00000010) != 0);
}
/**
*
**
* Read dataset starting at the row with the given offset (optional).
*
* If specified the server will start the read operation at the given row offset.
* Can be combined with the limit parameter to achieve pagination.
* If the offset is greater than the size of the dataset, no rows will be returned.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 offset = 5;
* @return The offset.
*/
@java.lang.Override
public long getOffset() {
return offset_;
}
/**
*
**
* Read dataset starting at the row with the given offset (optional).
*
* If specified the server will start the read operation at the given row offset.
* Can be combined with the limit parameter to achieve pagination.
* If the offset is greater than the size of the dataset, no rows will be returned.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 offset = 5;
* @param value The offset to set.
* @return This builder for chaining.
*/
public Builder setOffset(long value) {
offset_ = value;
bitField0_ |= 0x00000010;
onChanged();
return this;
}
/**
*
**
* Read dataset starting at the row with the given offset (optional).
*
* If specified the server will start the read operation at the given row offset.
* Can be combined with the limit parameter to achieve pagination.
* If the offset is greater than the size of the dataset, no rows will be returned.
*
* The returned rows are not ordered however ordering is guaranteed
* to stay the same for any particular dataset, i.e. two requests for the
* same dataset will return rows in the same order. If the dataset is
* expunged and recreated on the platform, e.g. by a re-run after an
* expired retention period, the ordering of the dataset may change.
*
*
* optional uint64 offset = 5;
* @return This builder for chaining.
*/
public Builder clearOffset() {
bitField0_ = (bitField0_ & ~0x00000010);
offset_ = 0L;
onChanged();
return this;
}
@java.lang.Override
public final Builder setUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:tracdap.api.DataReadRequest)
}
// @@protoc_insertion_point(class_scope:tracdap.api.DataReadRequest)
private static final org.finos.tracdap.api.DataReadRequest DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new org.finos.tracdap.api.DataReadRequest();
}
public static org.finos.tracdap.api.DataReadRequest getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser
PARSER = new com.google.protobuf.AbstractParser() {
@java.lang.Override
public DataReadRequest parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
Builder builder = newBuilder();
try {
builder.mergeFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(builder.buildPartial());
} catch (com.google.protobuf.UninitializedMessageException e) {
throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial());
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(e)
.setUnfinishedMessage(builder.buildPartial());
}
return builder.buildPartial();
}
};
public static com.google.protobuf.Parser parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser getParserForType() {
return PARSER;
}
@java.lang.Override
public org.finos.tracdap.api.DataReadRequest getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}