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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
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

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PushItem

Returns a new instance of PushItem



3047
3048
3049
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3047

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#content_hashString

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)


3001
3002
3003
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3001

def content_hash
  @content_hash
end

#metadata_hashString

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)


3011
3012
3013
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3011

def 
  @metadata_hash
end

#payloadString

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)


3019
3020
3021
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3019

def payload
  @payload
end

#queueString

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

Returns:

  • (String)


3026
3027
3028
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3026

def queue
  @queue
end

#repository_errorGoogle::Apis::CloudsearchV1::RepositoryError

Errors when the connector is communicating to the source repository. Corresponds to the JSON property repositoryError



3031
3032
3033
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3031

def repository_error
  @repository_error
end

#structured_data_hashString

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)


3040
3041
3042
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3040

def structured_data_hash
  @structured_data_hash
end

#typeString

The type of the push operation that defines the push behavior. Corresponds to the JSON property type

Returns:

  • (String)


3045
3046
3047
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3045

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3052
3053
3054
3055
3056
3057
3058
3059
3060
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3052

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