Class: Google::Cloud::Datastore::Admin::V1::Index

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

Overview

Datastore composite index definition.

Defined Under Namespace

Modules: AncestorMode, Direction, State Classes: IndexedProperty

Instance Attribute Summary collapse

Instance Attribute Details

#ancestor ⇒ ::Google::Cloud::Datastore::Admin::V1::Index::AncestorMode

Returns Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/datastore/admin/v1/index.rb', line 49

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

  # A property of an index.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The property name to index.
  # @!attribute [rw] direction
  #   @return [::Google::Cloud::Datastore::Admin::V1::Index::Direction]
  #     Required. The indexed property's direction.  Must not be
  #     DIRECTION_UNSPECIFIED.
  class IndexedProperty
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # For an ordered index, specifies whether each of the entity's ancestors
  # will be included.
  module AncestorMode
    # The ancestor mode is unspecified.
    ANCESTOR_MODE_UNSPECIFIED = 0

    # Do not include the entity's ancestors in the index.
    NONE = 1

    # Include all the entity's ancestors in the index.
    ALL_ANCESTORS = 2
  end

  # The direction determines how a property is indexed.
  module Direction
    # The direction is unspecified.
    DIRECTION_UNSPECIFIED = 0

    # The property's values are indexed so as to support sequencing in
    # ascending order and also query by <, >, <=, >=, and =.
    ASCENDING = 1

    # The property's values are indexed so as to support sequencing in
    # descending order and also query by <, >, <=, >=, and =.
    DESCENDING = 2
  end

  # The possible set of states of an index.
  module State
    # The state is unspecified.
    STATE_UNSPECIFIED = 0

    # The index is being created, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is updated when writing an entity.
    # Some index data may exist.
    CREATING = 1

    # The index is ready to be used.
    # The index is updated when writing an entity.
    # The index is fully populated from all stored entities it applies to.
    READY = 2

    # The index is being deleted, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    DELETING = 3

    # The index was being created or deleted, but something went wrong.
    # The index cannot by used by queries.
    # There is no active long-running operation for the index,
    # and the most recently finished long-running operation failed.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    ERROR = 4
  end
end

#index_id ⇒ ::String (readonly)

Returns Output only. The resource ID of the index.

Returns:

  • (::String) —

    Output only. The resource ID of the index.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/datastore/admin/v1/index.rb', line 49

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

  # A property of an index.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The property name to index.
  # @!attribute [rw] direction
  #   @return [::Google::Cloud::Datastore::Admin::V1::Index::Direction]
  #     Required. The indexed property's direction.  Must not be
  #     DIRECTION_UNSPECIFIED.
  class IndexedProperty
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # For an ordered index, specifies whether each of the entity's ancestors
  # will be included.
  module AncestorMode
    # The ancestor mode is unspecified.
    ANCESTOR_MODE_UNSPECIFIED = 0

    # Do not include the entity's ancestors in the index.
    NONE = 1

    # Include all the entity's ancestors in the index.
    ALL_ANCESTORS = 2
  end

  # The direction determines how a property is indexed.
  module Direction
    # The direction is unspecified.
    DIRECTION_UNSPECIFIED = 0

    # The property's values are indexed so as to support sequencing in
    # ascending order and also query by <, >, <=, >=, and =.
    ASCENDING = 1

    # The property's values are indexed so as to support sequencing in
    # descending order and also query by <, >, <=, >=, and =.
    DESCENDING = 2
  end

  # The possible set of states of an index.
  module State
    # The state is unspecified.
    STATE_UNSPECIFIED = 0

    # The index is being created, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is updated when writing an entity.
    # Some index data may exist.
    CREATING = 1

    # The index is ready to be used.
    # The index is updated when writing an entity.
    # The index is fully populated from all stored entities it applies to.
    READY = 2

    # The index is being deleted, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    DELETING = 3

    # The index was being created or deleted, but something went wrong.
    # The index cannot by used by queries.
    # There is no active long-running operation for the index,
    # and the most recently finished long-running operation failed.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    ERROR = 4
  end
end

#kind ⇒ ::String

Returns Required. The entity kind to which this index applies.

Returns:

  • (::String) —

    Required. The entity kind to which this index applies.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/datastore/admin/v1/index.rb', line 49

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

  # A property of an index.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The property name to index.
  # @!attribute [rw] direction
  #   @return [::Google::Cloud::Datastore::Admin::V1::Index::Direction]
  #     Required. The indexed property's direction.  Must not be
  #     DIRECTION_UNSPECIFIED.
  class IndexedProperty
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # For an ordered index, specifies whether each of the entity's ancestors
  # will be included.
  module AncestorMode
    # The ancestor mode is unspecified.
    ANCESTOR_MODE_UNSPECIFIED = 0

    # Do not include the entity's ancestors in the index.
    NONE = 1

    # Include all the entity's ancestors in the index.
    ALL_ANCESTORS = 2
  end

  # The direction determines how a property is indexed.
  module Direction
    # The direction is unspecified.
    DIRECTION_UNSPECIFIED = 0

    # The property's values are indexed so as to support sequencing in
    # ascending order and also query by <, >, <=, >=, and =.
    ASCENDING = 1

    # The property's values are indexed so as to support sequencing in
    # descending order and also query by <, >, <=, >=, and =.
    DESCENDING = 2
  end

  # The possible set of states of an index.
  module State
    # The state is unspecified.
    STATE_UNSPECIFIED = 0

    # The index is being created, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is updated when writing an entity.
    # Some index data may exist.
    CREATING = 1

    # The index is ready to be used.
    # The index is updated when writing an entity.
    # The index is fully populated from all stored entities it applies to.
    READY = 2

    # The index is being deleted, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    DELETING = 3

    # The index was being created or deleted, but something went wrong.
    # The index cannot by used by queries.
    # There is no active long-running operation for the index,
    # and the most recently finished long-running operation failed.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    ERROR = 4
  end
end

#project_id ⇒ ::String (readonly)

Returns Output only. Project ID.

Returns:

  • (::String) —

    Output only. Project ID.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/datastore/admin/v1/index.rb', line 49

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

  # A property of an index.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The property name to index.
  # @!attribute [rw] direction
  #   @return [::Google::Cloud::Datastore::Admin::V1::Index::Direction]
  #     Required. The indexed property's direction.  Must not be
  #     DIRECTION_UNSPECIFIED.
  class IndexedProperty
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # For an ordered index, specifies whether each of the entity's ancestors
  # will be included.
  module AncestorMode
    # The ancestor mode is unspecified.
    ANCESTOR_MODE_UNSPECIFIED = 0

    # Do not include the entity's ancestors in the index.
    NONE = 1

    # Include all the entity's ancestors in the index.
    ALL_ANCESTORS = 2
  end

  # The direction determines how a property is indexed.
  module Direction
    # The direction is unspecified.
    DIRECTION_UNSPECIFIED = 0

    # The property's values are indexed so as to support sequencing in
    # ascending order and also query by <, >, <=, >=, and =.
    ASCENDING = 1

    # The property's values are indexed so as to support sequencing in
    # descending order and also query by <, >, <=, >=, and =.
    DESCENDING = 2
  end

  # The possible set of states of an index.
  module State
    # The state is unspecified.
    STATE_UNSPECIFIED = 0

    # The index is being created, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is updated when writing an entity.
    # Some index data may exist.
    CREATING = 1

    # The index is ready to be used.
    # The index is updated when writing an entity.
    # The index is fully populated from all stored entities it applies to.
    READY = 2

    # The index is being deleted, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    DELETING = 3

    # The index was being created or deleted, but something went wrong.
    # The index cannot by used by queries.
    # There is no active long-running operation for the index,
    # and the most recently finished long-running operation failed.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    ERROR = 4
  end
end

#properties ⇒ ::Array<::Google::Cloud::Datastore::Admin::V1::Index::IndexedProperty>

Returns Required. An ordered sequence of property names and their index attributes.

Requires:

  • A maximum of 100 properties.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/datastore/admin/v1/index.rb', line 49

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

  # A property of an index.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The property name to index.
  # @!attribute [rw] direction
  #   @return [::Google::Cloud::Datastore::Admin::V1::Index::Direction]
  #     Required. The indexed property's direction.  Must not be
  #     DIRECTION_UNSPECIFIED.
  class IndexedProperty
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # For an ordered index, specifies whether each of the entity's ancestors
  # will be included.
  module AncestorMode
    # The ancestor mode is unspecified.
    ANCESTOR_MODE_UNSPECIFIED = 0

    # Do not include the entity's ancestors in the index.
    NONE = 1

    # Include all the entity's ancestors in the index.
    ALL_ANCESTORS = 2
  end

  # The direction determines how a property is indexed.
  module Direction
    # The direction is unspecified.
    DIRECTION_UNSPECIFIED = 0

    # The property's values are indexed so as to support sequencing in
    # ascending order and also query by <, >, <=, >=, and =.
    ASCENDING = 1

    # The property's values are indexed so as to support sequencing in
    # descending order and also query by <, >, <=, >=, and =.
    DESCENDING = 2
  end

  # The possible set of states of an index.
  module State
    # The state is unspecified.
    STATE_UNSPECIFIED = 0

    # The index is being created, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is updated when writing an entity.
    # Some index data may exist.
    CREATING = 1

    # The index is ready to be used.
    # The index is updated when writing an entity.
    # The index is fully populated from all stored entities it applies to.
    READY = 2

    # The index is being deleted, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    DELETING = 3

    # The index was being created or deleted, but something went wrong.
    # The index cannot by used by queries.
    # There is no active long-running operation for the index,
    # and the most recently finished long-running operation failed.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    ERROR = 4
  end
end

#state ⇒ ::Google::Cloud::Datastore::Admin::V1::Index::State (readonly)

Returns Output only. The state of the index.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/datastore/admin/v1/index.rb', line 49

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

  # A property of an index.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The property name to index.
  # @!attribute [rw] direction
  #   @return [::Google::Cloud::Datastore::Admin::V1::Index::Direction]
  #     Required. The indexed property's direction.  Must not be
  #     DIRECTION_UNSPECIFIED.
  class IndexedProperty
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # For an ordered index, specifies whether each of the entity's ancestors
  # will be included.
  module AncestorMode
    # The ancestor mode is unspecified.
    ANCESTOR_MODE_UNSPECIFIED = 0

    # Do not include the entity's ancestors in the index.
    NONE = 1

    # Include all the entity's ancestors in the index.
    ALL_ANCESTORS = 2
  end

  # The direction determines how a property is indexed.
  module Direction
    # The direction is unspecified.
    DIRECTION_UNSPECIFIED = 0

    # The property's values are indexed so as to support sequencing in
    # ascending order and also query by <, >, <=, >=, and =.
    ASCENDING = 1

    # The property's values are indexed so as to support sequencing in
    # descending order and also query by <, >, <=, >=, and =.
    DESCENDING = 2
  end

  # The possible set of states of an index.
  module State
    # The state is unspecified.
    STATE_UNSPECIFIED = 0

    # The index is being created, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is updated when writing an entity.
    # Some index data may exist.
    CREATING = 1

    # The index is ready to be used.
    # The index is updated when writing an entity.
    # The index is fully populated from all stored entities it applies to.
    READY = 2

    # The index is being deleted, and cannot be used by queries.
    # There is an active long-running operation for the index.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    DELETING = 3

    # The index was being created or deleted, but something went wrong.
    # The index cannot by used by queries.
    # There is no active long-running operation for the index,
    # and the most recently finished long-running operation failed.
    # The index is not updated when writing an entity.
    # Some index data may exist.
    ERROR = 4
  end
end