Class: Google::Apis::CloudtasksV2::UriOverride

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudtasks_v2/classes.rb,
lib/google/apis/cloudtasks_v2/representations.rb,
lib/google/apis/cloudtasks_v2/representations.rb

Overview

URI Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UriOverride

Returns a new instance of UriOverride.



1837
1838
1839
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1837

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

Instance Attribute Details

#host ⇒ String

Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT). Corresponds to the JSON property host

Returns:

  • (String) 


1804
1805
1806
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1804

def host
  @host
end

#path_override ⇒ Google::Apis::CloudtasksV2::PathOverride

PathOverride. Path message defines path override for HTTP targets. Corresponds to the JSON property pathOverride

Returns:



1809
1810
1811
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1809

def path_override
  @path_override
end

#port ⇒ Fixnum

Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port. Corresponds to the JSON property port

Returns:

  • (Fixnum) 


1818
1819
1820
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1818

def port
  @port
end

#query_override ⇒ Google::Apis::CloudtasksV2::QueryOverride

QueryOverride. Query message defines query override for HTTP targets. Corresponds to the JSON property queryOverride

Returns:



1823
1824
1825
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1823

def query_override
  @query_override
end

#scheme ⇒ String

Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS). Corresponds to the JSON property scheme

Returns:

  • (String) 


1829
1830
1831
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1829

def scheme
  @scheme
end

#uri_override_enforce_mode ⇒ String

URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS. Corresponds to the JSON property uriOverrideEnforceMode

Returns:

  • (String) 


1835
1836
1837
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1835

def uri_override_enforce_mode
  @uri_override_enforce_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1842
1843
1844
1845
1846
1847
1848
1849
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 1842

def update!(**args)
  @host = args[:host] if args.key?(:host)
  @path_override = args[:path_override] if args.key?(:path_override)
  @port = args[:port] if args.key?(:port)
  @query_override = args[:query_override] if args.key?(:query_override)
  @scheme = args[:scheme] if args.key?(:scheme)
  @uri_override_enforce_mode = args[:uri_override_enforce_mode] if args.key?(:uri_override_enforce_mode)
end