Class: Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb

Overview

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

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when the QueryTemplate was created.

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 121

class QueryTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The QueryTemplate lifecycle state.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The QueryTemplate is in draft state.
    DRAFTED = 1

    # The QueryTemplate is in pending state.
    PENDING = 2

    # The QueryTemplate is in deleted state.
    DELETED = 3

    # The QueryTemplate is in approved state.
    APPROVED = 4
  end
end

#description ⇒ ::String

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

Returns:

  • (::String) —

    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.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 121

class QueryTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The QueryTemplate lifecycle state.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The QueryTemplate is in draft state.
    DRAFTED = 1

    # The QueryTemplate is in pending state.
    PENDING = 2

    # The QueryTemplate is in deleted state.
    DELETED = 3

    # The QueryTemplate is in approved state.
    APPROVED = 4
  end
end

#display_name ⇒ ::String

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

Returns:

  • (::String) —

    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.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 121

class QueryTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The QueryTemplate lifecycle state.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The QueryTemplate is in draft state.
    DRAFTED = 1

    # The QueryTemplate is in pending state.
    PENDING = 2

    # The QueryTemplate is in deleted state.
    DELETED = 3

    # The QueryTemplate is in approved state.
    APPROVED = 4
  end
end

#documentation ⇒ ::String

Returns Optional. Documentation describing the QueryTemplate.

Returns:

  • (::String) —

    Optional. Documentation describing the QueryTemplate.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 121

class QueryTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The QueryTemplate lifecycle state.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The QueryTemplate is in draft state.
    DRAFTED = 1

    # The QueryTemplate is in pending state.
    PENDING = 2

    # The QueryTemplate is in deleted state.
    DELETED = 3

    # The QueryTemplate is in approved state.
    APPROVED = 4
  end
end

#name ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 121

class QueryTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The QueryTemplate lifecycle state.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The QueryTemplate is in draft state.
    DRAFTED = 1

    # The QueryTemplate is in pending state.
    PENDING = 2

    # The QueryTemplate is in deleted state.
    DELETED = 3

    # The QueryTemplate is in approved state.
    APPROVED = 4
  end
end

#primary_contact ⇒ ::String

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

Returns:

  • (::String) —

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 121

class QueryTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The QueryTemplate lifecycle state.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The QueryTemplate is in draft state.
    DRAFTED = 1

    # The QueryTemplate is in pending state.
    PENDING = 2

    # The QueryTemplate is in deleted state.
    DELETED = 3

    # The QueryTemplate is in approved state.
    APPROVED = 4
  end
end

#proposer ⇒ ::String

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

Returns:

  • (::String) —

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 121

class QueryTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The QueryTemplate lifecycle state.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The QueryTemplate is in draft state.
    DRAFTED = 1

    # The QueryTemplate is in pending state.
    PENDING = 2

    # The QueryTemplate is in deleted state.
    DELETED = 3

    # The QueryTemplate is in approved state.
    APPROVED = 4
  end
end

#routine ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::Routine

Returns Optional. The routine associated with the QueryTemplate.

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 121

class QueryTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The QueryTemplate lifecycle state.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The QueryTemplate is in draft state.
    DRAFTED = 1

    # The QueryTemplate is in pending state.
    PENDING = 2

    # The QueryTemplate is in deleted state.
    DELETED = 3

    # The QueryTemplate is in approved state.
    APPROVED = 4
  end
end

#state ⇒ ::Google::Cloud::Bigquery::AnalyticsHub::V1::QueryTemplate::State (readonly)

Returns Output only. The QueryTemplate lifecycle state.

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 121

class QueryTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The QueryTemplate lifecycle state.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The QueryTemplate is in draft state.
    DRAFTED = 1

    # The QueryTemplate is in pending state.
    PENDING = 2

    # The QueryTemplate is in deleted state.
    DELETED = 3

    # The QueryTemplate is in approved state.
    APPROVED = 4
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when the QueryTemplate was last modified.

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/bigquery/analyticshub/v1/analyticshub.rb', line 121

class QueryTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The QueryTemplate lifecycle state.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The QueryTemplate is in draft state.
    DRAFTED = 1

    # The QueryTemplate is in pending state.
    PENDING = 2

    # The QueryTemplate is in deleted state.
    DELETED = 3

    # The QueryTemplate is in approved state.
    APPROVED = 4
  end
end