com.google.cloud.bigquery.analyticshub.v1

Class QueryTemplate

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.bigquery.analyticshub.v1.QueryTemplate

All Implemented Interfaces:

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

public final class QueryTemplate
extends com.google.protobuf.GeneratedMessageV3
implements QueryTemplateOrBuilder

 A query template is a container for sharing table-valued functions defined by
 contributors in a data clean room.
 

Protobuf type google.cloud.bigquery.analyticshub.v1.QueryTemplate

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryTemplate.Builder A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
static class	QueryTemplate.State The QueryTemplate lifecycle state.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATE_TIME_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	DOCUMENTATION_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PRIMARY_CONTACT_FIELD_NUMBER
static int	PROPOSER_FIELD_NUMBER
static int	ROUTINE_FIELD_NUMBER
static int	STATE_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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 and Description
boolean	equals(Object obj)
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
static QueryTemplate	getDefaultInstance()
QueryTemplate	getDefaultInstanceForType()
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
String	getDocumentation() Optional.
com.google.protobuf.ByteString	getDocumentationBytes() Optional.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
com.google.protobuf.Parser<QueryTemplate>	getParserForType()
String	getPrimaryContact() Optional.
com.google.protobuf.ByteString	getPrimaryContactBytes() Optional.
String	getProposer() Optional.
com.google.protobuf.ByteString	getProposerBytes() Optional.
Routine	getRoutine() Optional.
RoutineOrBuilder	getRoutineOrBuilder() Optional.
int	getSerializedSize()
QueryTemplate.State	getState() Output only.
int	getStateValue() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
int	hashCode()
boolean	hasRoutine() Optional.
boolean	hasUpdateTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static QueryTemplate.Builder	newBuilder()
static QueryTemplate.Builder	newBuilder(QueryTemplate prototype)
QueryTemplate.Builder	newBuilderForType()
protected QueryTemplate.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static QueryTemplate	parseDelimitedFrom(InputStream input)
static QueryTemplate	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryTemplate	parseFrom(byte[] data)
static QueryTemplate	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryTemplate	parseFrom(ByteBuffer data)
static QueryTemplate	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryTemplate	parseFrom(com.google.protobuf.ByteString data)
static QueryTemplate	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryTemplate	parseFrom(com.google.protobuf.CodedInputStream input)
static QueryTemplate	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryTemplate	parseFrom(InputStream input)
static QueryTemplate	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<QueryTemplate>	parser()
QueryTemplate.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

PROPOSER_FIELD_NUMBER

public static final int PROPOSER_FIELD_NUMBER

See Also:

Constant Field Values

PRIMARY_CONTACT_FIELD_NUMBER

public static final int PRIMARY_CONTACT_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENTATION_FIELD_NUMBER

public static final int DOCUMENTATION_FIELD_NUMBER

See Also:

Constant Field Values

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

ROUTINE_FIELD_NUMBER

public static final int ROUTINE_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

getName

public String getName()

 Output only. The resource name of the QueryTemplate.
 e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getName in interface QueryTemplateOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Output only. The resource name of the QueryTemplate.
 e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getNameBytes in interface QueryTemplateOrBuilder

Returns:

The bytes for name.

getDisplayName

public String getDisplayName()

 Required. Human-readable display name of the QueryTemplate. The display
 name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces.
 Default value is an empty string. Max length: 63 bytes.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayName in interface QueryTemplateOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 Required. Human-readable display name of the QueryTemplate. The display
 name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces.
 Default value is an empty string. Max length: 63 bytes.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayNameBytes in interface QueryTemplateOrBuilder

Returns:

The bytes for displayName.

getDescription

public String getDescription()

 Optional. Short description of the QueryTemplate. The description must not
 contain Unicode non-characters and C0 and C1 control codes except tabs
 (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default
 value is an empty string. Max length: 2000 bytes.
 

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDescription in interface QueryTemplateOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Optional. Short description of the QueryTemplate. The description must not
 contain Unicode non-characters and C0 and C1 control codes except tabs
 (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default
 value is an empty string. Max length: 2000 bytes.
 

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDescriptionBytes in interface QueryTemplateOrBuilder

Returns:

The bytes for description.

getProposer

public String getProposer()

 Optional. Will be deprecated.
 Email or URL of the primary point of contact of the QueryTemplate.
 Max Length: 1000 bytes.
 

string proposer = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getProposer in interface QueryTemplateOrBuilder

Returns:

The proposer.

getProposerBytes

public com.google.protobuf.ByteString getProposerBytes()

 Optional. Will be deprecated.
 Email or URL of the primary point of contact of the QueryTemplate.
 Max Length: 1000 bytes.
 

string proposer = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getProposerBytes in interface QueryTemplateOrBuilder

Returns:

The bytes for proposer.

getPrimaryContact

public String getPrimaryContact()

 Optional. Email or URL of the primary point of contact of the
 QueryTemplate. Max Length: 1000 bytes.
 

string primary_contact = 10 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPrimaryContact in interface QueryTemplateOrBuilder

Returns:

The primaryContact.

getPrimaryContactBytes

public com.google.protobuf.ByteString getPrimaryContactBytes()

 Optional. Email or URL of the primary point of contact of the
 QueryTemplate. Max Length: 1000 bytes.
 

string primary_contact = 10 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPrimaryContactBytes in interface QueryTemplateOrBuilder

Returns:

The bytes for primaryContact.

getDocumentation

public String getDocumentation()

 Optional. Documentation describing the QueryTemplate.
 

string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDocumentation in interface QueryTemplateOrBuilder

Returns:

The documentation.

getDocumentationBytes

public com.google.protobuf.ByteString getDocumentationBytes()

 Optional. Documentation describing the QueryTemplate.
 

string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDocumentationBytes in interface QueryTemplateOrBuilder

Returns:

The bytes for documentation.

getStateValue

public int getStateValue()

 Output only. The QueryTemplate lifecycle state.
 

.google.cloud.bigquery.analyticshub.v1.QueryTemplate.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getStateValue in interface QueryTemplateOrBuilder

Returns:

The enum numeric value on the wire for state.

getState

public QueryTemplate.State getState()

 Output only. The QueryTemplate lifecycle state.
 

.google.cloud.bigquery.analyticshub.v1.QueryTemplate.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getState in interface QueryTemplateOrBuilder

Returns:

The state.

hasRoutine

public boolean hasRoutine()

 Optional. The routine associated with the QueryTemplate.
 

.google.cloud.bigquery.analyticshub.v1.Routine routine = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasRoutine in interface QueryTemplateOrBuilder

Returns:

Whether the routine field is set.

getRoutine

public Routine getRoutine()

 Optional. The routine associated with the QueryTemplate.
 

.google.cloud.bigquery.analyticshub.v1.Routine routine = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRoutine in interface QueryTemplateOrBuilder

Returns:

The routine.

getRoutineOrBuilder

public RoutineOrBuilder getRoutineOrBuilder()

 Optional. The routine associated with the QueryTemplate.
 

.google.cloud.bigquery.analyticshub.v1.Routine routine = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRoutineOrBuilder in interface QueryTemplateOrBuilder

hasCreateTime

public boolean hasCreateTime()

 Output only. Timestamp when the QueryTemplate was created.
 

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasCreateTime in interface QueryTemplateOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when the QueryTemplate was created.
 

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCreateTime in interface QueryTemplateOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when the QueryTemplate was created.
 

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCreateTimeOrBuilder in interface QueryTemplateOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 Output only. Timestamp when the QueryTemplate was last modified.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasUpdateTime in interface QueryTemplateOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 Output only. Timestamp when the QueryTemplate was last modified.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getUpdateTime in interface QueryTemplateOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Timestamp when the QueryTemplate was last modified.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getUpdateTimeOrBuilder in interface QueryTemplateOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 QueryTemplate parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryTemplate parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static QueryTemplate parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public QueryTemplate.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static QueryTemplate.Builder newBuilder()

newBuilder

public static QueryTemplate.Builder newBuilder(QueryTemplate prototype)

toBuilder

public QueryTemplate.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected QueryTemplate.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static QueryTemplate getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<QueryTemplate> 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.GeneratedMessageV3

getDefaultInstanceForType

public QueryTemplate getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder