Class: Google::Apis::CloudsearchV1::PollItemsRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PollItemsRequest

Returns a new instance of PollItemsRequest.



2759
2760
2761
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2759

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

Instance Attribute Details

#connector_nameString

Name of connector making this call. Format: datasources/source_id/connectors/ ID Corresponds to the JSON property connectorName

Returns:

  • (String)


2735
2736
2737
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2735

def connector_name
  @connector_name
end

#debug_optionsGoogle::Apis::CloudsearchV1::DebugOptions

Shared request debug options for all cloudsearch RPC methods. Corresponds to the JSON property debugOptions



2740
2741
2742
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2740

def debug_options
  @debug_options
end

#limitFixnum

Maximum number of items to return. The maximum value is 100 and the default value is 20. Corresponds to the JSON property limit

Returns:

  • (Fixnum)


2746
2747
2748
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2746

def limit
  @limit
end

#queueString

Queue name to fetch items from. If unspecified, PollItems will fetch from ' default' queue. The maximum length is 100 characters. Corresponds to the JSON property queue

Returns:

  • (String)


2752
2753
2754
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2752

def queue
  @queue
end

#status_codesArray<String>

Limit the items polled to the ones with these statuses. Corresponds to the JSON property statusCodes

Returns:

  • (Array<String>)


2757
2758
2759
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2757

def status_codes
  @status_codes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2764
2765
2766
2767
2768
2769
2770
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2764

def update!(**args)
  @connector_name = args[:connector_name] if args.key?(:connector_name)
  @debug_options = args[:debug_options] if args.key?(:debug_options)
  @limit = args[:limit] if args.key?(:limit)
  @queue = args[:queue] if args.key?(:queue)
  @status_codes = args[:status_codes] if args.key?(:status_codes)
end