com.google.cloud.bigquery.analyticshub.v1

Interface QueryTemplateOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

QueryTemplate, QueryTemplate.Builder

public interface QueryTemplateOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
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.
String	getPrimaryContact() Optional.
com.google.protobuf.ByteString	getPrimaryContactBytes() Optional.
String	getProposer() Optional.
com.google.protobuf.ByteString	getProposerBytes() Optional.
Routine	getRoutine() Optional.
RoutineOrBuilder	getRoutineOrBuilder() Optional.
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.
boolean	hasRoutine() Optional.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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];

Returns:

The name.

getNameBytes

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];

Returns:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

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];

Returns:

The bytes for displayName.

getDescription

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:

The description.

getDescriptionBytes

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];

Returns:

The bytes for description.

getProposer

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:

The proposer.

getProposerBytes

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];

Returns:

The bytes for proposer.

getPrimaryContact

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:

The primaryContact.

getPrimaryContactBytes

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];

Returns:

The bytes for primaryContact.

getDocumentation

String getDocumentation()

 Optional. Documentation describing the QueryTemplate.
 

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

Returns:

The documentation.

getDocumentationBytes

com.google.protobuf.ByteString getDocumentationBytes()

 Optional. Documentation describing the QueryTemplate.
 

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

Returns:

The bytes for documentation.

getStateValue

int getStateValue()

 Output only. The QueryTemplate lifecycle state.
 

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

Returns:

The enum numeric value on the wire for state.

getState

QueryTemplate.State getState()

 Output only. The QueryTemplate lifecycle state.
 

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

Returns:

The state.

hasRoutine

boolean hasRoutine()

 Optional. The routine associated with the QueryTemplate.
 

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

Returns:

Whether the routine field is set.

getRoutine

Routine getRoutine()

 Optional. The routine associated with the QueryTemplate.
 

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

Returns:

The routine.

getRoutineOrBuilder

RoutineOrBuilder getRoutineOrBuilder()

 Optional. The routine associated with the QueryTemplate.
 

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

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when the QueryTemplate was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

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];

Returns:

The createTime.

getCreateTimeOrBuilder

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];

hasUpdateTime

boolean hasUpdateTime()

 Output only. Timestamp when the QueryTemplate was last modified.
 

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

Returns:

Whether the updateTime field is set.

getUpdateTime

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];

Returns:

The updateTime.

getUpdateTimeOrBuilder

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];