Class: Google::Cloud::Metastore::V1::Federation

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

Overview

Represents a federation of multiple backend metastores.

Defined Under Namespace

Modules: State Classes: BackendMetastoresEntry, LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#backend_metastores ⇒ ::Google::Protobuf::Map{::Integer => ::Google::Cloud::Metastore::V1::BackendMetastore}

Returns A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.

Returns:

  • (::Google::Protobuf::Map{::Integer => ::Google::Cloud::Metastore::V1::BackendMetastore}) —

    A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/metastore/v1/metastore_federation.rb', line 65

class Federation
  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

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Metastore::V1::BackendMetastore]
  class BackendMetastoresEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

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

    # The metastore federation is undergoing deletion. It cannot be used.
    DELETING = 4

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

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

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

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/metastore/v1/metastore_federation.rb', line 65

class Federation
  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

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Metastore::V1::BackendMetastore]
  class BackendMetastoresEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

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

    # The metastore federation is undergoing deletion. It cannot be used.
    DELETING = 4

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

#endpoint_uri ⇒ ::String (readonly)

Returns Output only. The federation endpoint.

Returns:

  • (::String) —

    Output only. The federation endpoint.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/metastore/v1/metastore_federation.rb', line 65

class Federation
  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

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Metastore::V1::BackendMetastore]
  class BackendMetastoresEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

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

    # The metastore federation is undergoing deletion. It cannot be used.
    DELETING = 4

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

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

Returns User-defined labels for the metastore federation.

Returns:

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

    User-defined labels for the metastore federation.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/metastore/v1/metastore_federation.rb', line 65

class Federation
  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

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Metastore::V1::BackendMetastore]
  class BackendMetastoresEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

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

    # The metastore federation is undergoing deletion. It cannot be used.
    DELETING = 4

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

#name ⇒ ::String

Returns Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.

Returns:

  • (::String) —

    Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/metastore/v1/metastore_federation.rb', line 65

class Federation
  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

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Metastore::V1::BackendMetastore]
  class BackendMetastoresEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

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

    # The metastore federation is undergoing deletion. It cannot be used.
    DELETING = 4

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

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

Returns Output only. The current state of the federation.

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/metastore/v1/metastore_federation.rb', line 65

class Federation
  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

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Metastore::V1::BackendMetastore]
  class BackendMetastoresEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

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

    # The metastore federation is undergoing deletion. It cannot be used.
    DELETING = 4

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

#state_message ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/metastore/v1/metastore_federation.rb', line 65

class Federation
  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

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Metastore::V1::BackendMetastore]
  class BackendMetastoresEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

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

    # The metastore federation is undergoing deletion. It cannot be used.
    DELETING = 4

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

#uid ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/metastore/v1/metastore_federation.rb', line 65

class Federation
  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

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Metastore::V1::BackendMetastore]
  class BackendMetastoresEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

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

    # The metastore federation is undergoing deletion. It cannot be used.
    DELETING = 4

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

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

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

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/metastore/v1/metastore_federation.rb', line 65

class Federation
  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

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Metastore::V1::BackendMetastore]
  class BackendMetastoresEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

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

    # The metastore federation is undergoing deletion. It cannot be used.
    DELETING = 4

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

#version ⇒ ::String

Returns Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.

Returns:

  • (::String) —

    Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/metastore/v1/metastore_federation.rb', line 65

class Federation
  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

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Metastore::V1::BackendMetastore]
  class BackendMetastoresEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

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

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

    # The metastore federation is undergoing deletion. It cannot be used.
    DELETING = 4

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