Class: Google::Apis::CloudsearchV1::PushItem
- Inherits:
-
Object
- Object
- Google::Apis::CloudsearchV1::PushItem
- Defined in:
- generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/google/apis/cloudsearch_v1/representations.rb
Overview
Represents an item to be pushed to the indexing queue.
Instance Attribute Summary collapse
-
#content_hash ⇒ String
Content hash of the item according to the repository.
-
#metadata_hash ⇒ String
Metadata hash of the item according to the repository.
-
#payload ⇒ String
Provides additional document state information for the connector, such as an alternate repository ID and other metadata.
-
#queue ⇒ String
Queue to which this item belongs to.
-
#repository_error ⇒ Google::Apis::CloudsearchV1::RepositoryError
Errors when the connector is communicating to the source repository.
-
#structured_data_hash ⇒ String
Structured data hash of the item according to the repository.
-
#type ⇒ String
The type of the push operation that defines the push behavior.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PushItem
constructor
A new instance of PushItem.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ PushItem
Returns a new instance of PushItem.
3173 3174 3175 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3173 def initialize(**args) update!(**args) end |
Instance Attribute Details
#content_hash ⇒ String
Content hash of the item according to the repository. If specified, this is
used to determine how to modify this
item's status. Setting this field and the
type field results in argument
error.
The maximum length is 2048 characters.
Corresponds to the JSON property contentHash
3127 3128 3129 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3127 def content_hash @content_hash end |
#metadata_hash ⇒ String
Metadata hash of the item according to the repository. If specified, this
is used to determine how to modify this
item's status. Setting this field and the
type field results in argument
error.
The maximum length is 2048 characters.
Corresponds to the JSON property metadataHash
3137 3138 3139 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3137 def @metadata_hash end |
#payload ⇒ String
Provides additional document state information for the connector,
such as an alternate repository ID and other metadata.
The maximum length is 8192 bytes.
Corresponds to the JSON property payload
NOTE: Values are automatically base64 encoded/decoded in the client library.
3145 3146 3147 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3145 def payload @payload end |
#queue ⇒ String
Queue to which this item belongs to. The default
queue is
chosen if this field is not specified. The maximum length is
512 characters.
Corresponds to the JSON property queue
3152 3153 3154 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3152 def queue @queue end |
#repository_error ⇒ Google::Apis::CloudsearchV1::RepositoryError
Errors when the connector is communicating to the source repository.
Corresponds to the JSON property repositoryError
3157 3158 3159 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3157 def repository_error @repository_error end |
#structured_data_hash ⇒ String
Structured data hash of the item according to the repository. If specified,
this is used to determine how to modify this item's status. Setting this
field and the type field
results in argument error.
The maximum length is 2048 characters.
Corresponds to the JSON property structuredDataHash
3166 3167 3168 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3166 def structured_data_hash @structured_data_hash end |
#type ⇒ String
The type of the push operation that defines the push behavior.
Corresponds to the JSON property type
3171 3172 3173 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3171 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3178 3179 3180 3181 3182 3183 3184 3185 3186 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3178 def update!(**args) @content_hash = args[:content_hash] if args.key?(:content_hash) @metadata_hash = args[:metadata_hash] if args.key?(:metadata_hash) @payload = args[:payload] if args.key?(:payload) @queue = args[:queue] if args.key?(:queue) @repository_error = args[:repository_error] if args.key?(:repository_error) @structured_data_hash = args[:structured_data_hash] if args.key?(:structured_data_hash) @type = args[:type] if args.key?(:type) end |