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

Constructor Details

#initialize(**args) ⇒ PushItem

Returns a new instance of PushItem.



3089
3090
3091
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3089

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)


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

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)


3056
3057
3058
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3056

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)


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

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)


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

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



3074
3075
3076
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3074

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)


3082
3083
3084
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3082

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)


3087
3088
3089
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3087

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3094
3095
3096
3097
3098
3099
3100
3101
3102
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3094

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