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



3069
3070
3071
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3069

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) 


3023
3024
3025
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3023

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) 


3033
3034
3035
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3033

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) 


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

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) 


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

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:



3053
3054
3055
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3053

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) 


3062
3063
3064
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3062

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) 


3067
3068
3069
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3067

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3074
3075
3076
3077
3078
3079
3080
3081
3082
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3074

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