public final class QueryTemplate extends 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DOCUMENTATION_FIELD_NUMBER
public static final int DOCUMENTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PRIMARY_CONTACT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROPOSER_FIELD_NUMBER
public static final int PROPOSER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ROUTINE_FIELD_NUMBER
public static final int ROUTINE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static QueryTemplate getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static QueryTemplate.Builder newBuilder()
newBuilder(QueryTemplate prototype)
public static QueryTemplate.Builder newBuilder(QueryTemplate prototype)
public static QueryTemplate parseDelimitedFrom(InputStream input)
public static QueryTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static QueryTemplate parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QueryTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static QueryTemplate parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryTemplate parseFrom(CodedInputStream input)
public static QueryTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryTemplate parseFrom(InputStream input)
public static QueryTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static QueryTemplate parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static QueryTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<QueryTemplate> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. Timestamp when the QueryTemplate was created.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when the QueryTemplate was created.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public QueryTemplate getDefaultInstanceForType()
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];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
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];
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getDocumentation()
public String getDocumentation()
Optional. Documentation describing the QueryTemplate.
string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The documentation.
|
getDocumentationBytes()
public ByteString getDocumentationBytes()
Optional. Documentation describing the QueryTemplate.
string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for documentation.
|
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];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<QueryTemplate> getParserForType()
Overrides
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];
| Returns |
| Type |
Description |
String |
The primaryContact.
|
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for primaryContact.
|
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];
| Returns |
| Type |
Description |
String |
The proposer.
|
getProposerBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for proposer.
|
getRoutine()
public Routine getRoutine()
Optional. The routine associated with the QueryTemplate.
.google.cloud.bigquery.analyticshub.v1.Routine routine = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Routine |
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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Timestamp when the QueryTemplate was last modified.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when the QueryTemplate was last modified.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Timestamp when the QueryTemplate was created.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasRoutine()
public boolean hasRoutine()
Optional. The routine associated with the QueryTemplate.
.google.cloud.bigquery.analyticshub.v1.Routine routine = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the routine field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public QueryTemplate.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected QueryTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public QueryTemplate.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
