Class: Google::Apis::CloudsearchV1::PushItem

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

Represents an item to be pushed to the indexing queue.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PushItem

Returns a new instance of PushItem.



6152
6153
6154
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6152

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

Returns:

  • (String) 


6111
6112
6113
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6111

def content_hash
  @content_hash
end

#metadata_hash ⇒ String

The 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

Returns:

  • (String) 


6119
6120
6121
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6119

def metadata_hash
  @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.

Returns:

  • (String) 


6126
6127
6128
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6126

def payload
  @payload
end

#queue ⇒ String

Queue to which this item belongs. The default queue is chosen if this field is not specified. The maximum length is 512 characters. Corresponds to the JSON property queue

Returns:

  • (String) 


6132
6133
6134
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6132

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

Returns:



6137
6138
6139
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6137

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

Returns:

  • (String) 


6145
6146
6147
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6145

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

Returns:

  • (String) 


6150
6151
6152
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6150

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6157
6158
6159
6160
6161
6162
6163
6164
6165
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6157

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