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



2928
2929
2930
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2928

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) 


2882
2883
2884
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2882

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

Returns:

  • (String) 


2892
2893
2894
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2892

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) 


2900
2901
2902
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2900

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

Returns:

  • (String) 


2907
2908
2909
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2907

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:



2912
2913
2914
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2912

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) 


2921
2922
2923
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2921

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) 


2926
2927
2928
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2926

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2933

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