Class: Google::Cloud::Metastore::V1::Service

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

Overview

A managed metastore service that serves metadata queries.

Defined Under Namespace

Modules: DatabaseType, ReleaseChannel, State, Tier Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#artifact_gcs_uri ⇒ ::String (readonly)

Returns Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

Returns:

  • (::String) —

    Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

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

Returns Output only. The time when the metastore service was created.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#database_type ⇒ ::Google::Cloud::Metastore::V1::Service::DatabaseType

Returns Immutable. The database type that the Metastore service stores its data.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#encryption_config ⇒ ::Google::Cloud::Metastore::V1::EncryptionConfig

Returns Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#endpoint_uri ⇒ ::String (readonly)

Returns Output only. The URI of the endpoint used to access the metastore service.

Returns:

  • (::String) —

    Output only. The URI of the endpoint used to access the metastore service.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#hive_metastore_config ⇒ ::Google::Cloud::Metastore::V1::HiveMetastoreConfig

Returns Configuration information specific to running Hive metastore software as the metastore service.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns User-defined labels for the metastore service.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    User-defined labels for the metastore service.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#maintenance_window ⇒ ::Google::Cloud::Metastore::V1::MaintenanceWindow

Returns The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type.

Returns:

  • (::Google::Cloud::Metastore::V1::MaintenanceWindow) —

    The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#metadata_management_activity ⇒ ::Google::Cloud::Metastore::V1::MetadataManagementActivity (readonly)

Returns Output only. The metadata management activities of the metastore service.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#name ⇒ ::String

Returns Immutable. The relative resource name of the metastore service, in the following format:

projects/{project_number}/locations/{location_id}/services/{service_id}.

Returns:

  • (::String) —

    Immutable. The relative resource name of the metastore service, in the following format:

    projects/{project_number}/locations/{location_id}/services/{service_id}.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#network ⇒ ::String

Returns Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:

projects/{project_number}/global/networks/{network_id}.

Returns:

  • (::String) —

    Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:

    projects/{project_number}/global/networks/{network_id}.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#network_config ⇒ ::Google::Cloud::Metastore::V1::NetworkConfig

Returns The configuration specifying the network settings for the Dataproc Metastore service.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#port ⇒ ::Integer

Returns The TCP port at which the metastore service is reached. Default: 9083.

Returns:

  • (::Integer) —

    The TCP port at which the metastore service is reached. Default: 9083.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#release_channel ⇒ ::Google::Cloud::Metastore::V1::Service::ReleaseChannel

Returns Immutable. The release channel of the service. If unspecified, defaults to STABLE.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#scaling_config ⇒ ::Google::Cloud::Metastore::V1::ScalingConfig

Returns Scaling configuration of the metastore service.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#state ⇒ ::Google::Cloud::Metastore::V1::Service::State (readonly)

Returns Output only. The current state of the metastore service.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#state_message ⇒ ::String (readonly)

Returns Output only. Additional information about the current state of the metastore service, if available.

Returns:

  • (::String) —

    Output only. Additional information about the current state of the metastore service, if available.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#telemetry_config ⇒ ::Google::Cloud::Metastore::V1::TelemetryConfig

Returns The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#tier ⇒ ::Google::Cloud::Metastore::V1::Service::Tier

Returns The tier of the service.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. The globally unique resource identifier of the metastore service.

Returns:

  • (::String) —

    Output only. The globally unique resource identifier of the metastore service.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end

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

Returns Output only. The time when the metastore service was last updated.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/metastore/v1/metastore.rb', line 105

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the metastore service.
  module State
    # The state of the metastore service is unknown.
    STATE_UNSPECIFIED = 0

    # The metastore service is in the process of being created.
    CREATING = 1

    # The metastore service is running and ready to serve queries.
    ACTIVE = 2

    # The metastore service is entering suspension. Its query-serving
    # availability may cease unexpectedly.
    SUSPENDING = 3

    # The metastore service is suspended and unable to serve queries.
    SUSPENDED = 4

    # The metastore service is being updated. It remains usable but cannot
    # accept additional update requests or be deleted at this time.
    UPDATING = 5

    # The metastore service is undergoing deletion. It cannot be used.
    DELETING = 6

    # The metastore service has encountered an error and cannot be used. The
    # metastore service should be deleted.
    ERROR = 7
  end

  # Available service tiers.
  module Tier
    # The tier is not set.
    TIER_UNSPECIFIED = 0

    # The developer tier provides limited scalability and no fault tolerance.
    # Good for low-cost proof-of-concept.
    DEVELOPER = 1

    # The enterprise tier provides multi-zone high availability, and sufficient
    # scalability for enterprise-level Dataproc Metastore workloads.
    ENTERPRISE = 3
  end

  # Release channels bundle features of varying levels of stability. Newer
  # features may be introduced initially into less stable release channels and
  # can be automatically promoted into more stable release channels.
  module ReleaseChannel
    # Release channel is not specified.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # The `CANARY` release channel contains the newest features, which may be
    # unstable and subject to unresolved issues with no known workarounds.
    # Services using the `CANARY` release channel are not subject to any SLAs.
    CANARY = 1

    # The `STABLE` release channel contains features that are considered stable
    # and have been validated for production use.
    STABLE = 2
  end

  # The backend database type for the metastore service.
  module DatabaseType
    # The DATABASE_TYPE is not set.
    DATABASE_TYPE_UNSPECIFIED = 0

    # MySQL is used to persist the metastore data.
    MYSQL = 1

    # Spanner is used to persist the metastore data.
    SPANNER = 2
  end
end