Class: Google::Cloud::Tasks::V2beta3::UriOverride

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/tasks/v2beta3/target.rb

Overview

URI Override.

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

Defined Under Namespace

Modules: Scheme, UriOverrideEnforceMode

Instance Attribute Summary collapse

Instance Attribute Details

#host ⇒ ::String

Returns 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).

Returns:

  • (::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).



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'proto_docs/google/cloud/tasks/v2beta3/target.rb', line 119

class UriOverride
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The Scheme for an HTTP request. By default, it is HTTPS.
  module Scheme
    # Scheme unspecified. Defaults to HTTPS.
    SCHEME_UNSPECIFIED = 0

    # Convert the scheme to HTTP, e.g., https://www.google.ca will change to
    # http://www.google.ca.
    HTTP = 1

    # Convert the scheme to HTTPS, e.g., http://www.google.ca will change to
    # https://www.google.ca.
    HTTPS = 2
  end

  # UriOverrideEnforceMode mode is to define enforcing mode for the override
  # modes.
  module UriOverrideEnforceMode
    # OverrideMode Unspecified. Defaults to ALWAYS.
    URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED = 0

    # In the IF_NOT_EXISTS mode, queue-level configuration is only
    # applied where task-level configuration does not exist.
    IF_NOT_EXISTS = 1

    # In the ALWAYS mode, queue-level configuration overrides all
    # task-level configuration
    ALWAYS = 2
  end
end

#path_override ⇒ ::Google::Cloud::Tasks::V2beta3::PathOverride

Returns URI path.

When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'proto_docs/google/cloud/tasks/v2beta3/target.rb', line 119

class UriOverride
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The Scheme for an HTTP request. By default, it is HTTPS.
  module Scheme
    # Scheme unspecified. Defaults to HTTPS.
    SCHEME_UNSPECIFIED = 0

    # Convert the scheme to HTTP, e.g., https://www.google.ca will change to
    # http://www.google.ca.
    HTTP = 1

    # Convert the scheme to HTTPS, e.g., http://www.google.ca will change to
    # https://www.google.ca.
    HTTPS = 2
  end

  # UriOverrideEnforceMode mode is to define enforcing mode for the override
  # modes.
  module UriOverrideEnforceMode
    # OverrideMode Unspecified. Defaults to ALWAYS.
    URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED = 0

    # In the IF_NOT_EXISTS mode, queue-level configuration is only
    # applied where task-level configuration does not exist.
    IF_NOT_EXISTS = 1

    # In the ALWAYS mode, queue-level configuration overrides all
    # task-level configuration
    ALWAYS = 2
  end
end

#port ⇒ ::Integer

Returns Port override.

When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.

Returns:

  • (::Integer) —

    Port override.

    When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'proto_docs/google/cloud/tasks/v2beta3/target.rb', line 119

class UriOverride
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The Scheme for an HTTP request. By default, it is HTTPS.
  module Scheme
    # Scheme unspecified. Defaults to HTTPS.
    SCHEME_UNSPECIFIED = 0

    # Convert the scheme to HTTP, e.g., https://www.google.ca will change to
    # http://www.google.ca.
    HTTP = 1

    # Convert the scheme to HTTPS, e.g., http://www.google.ca will change to
    # https://www.google.ca.
    HTTPS = 2
  end

  # UriOverrideEnforceMode mode is to define enforcing mode for the override
  # modes.
  module UriOverrideEnforceMode
    # OverrideMode Unspecified. Defaults to ALWAYS.
    URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED = 0

    # In the IF_NOT_EXISTS mode, queue-level configuration is only
    # applied where task-level configuration does not exist.
    IF_NOT_EXISTS = 1

    # In the ALWAYS mode, queue-level configuration overrides all
    # task-level configuration
    ALWAYS = 2
  end
end

#query_override ⇒ ::Google::Cloud::Tasks::V2beta3::QueryOverride

Returns URI Query.

When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'proto_docs/google/cloud/tasks/v2beta3/target.rb', line 119

class UriOverride
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The Scheme for an HTTP request. By default, it is HTTPS.
  module Scheme
    # Scheme unspecified. Defaults to HTTPS.
    SCHEME_UNSPECIFIED = 0

    # Convert the scheme to HTTP, e.g., https://www.google.ca will change to
    # http://www.google.ca.
    HTTP = 1

    # Convert the scheme to HTTPS, e.g., http://www.google.ca will change to
    # https://www.google.ca.
    HTTPS = 2
  end

  # UriOverrideEnforceMode mode is to define enforcing mode for the override
  # modes.
  module UriOverrideEnforceMode
    # OverrideMode Unspecified. Defaults to ALWAYS.
    URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED = 0

    # In the IF_NOT_EXISTS mode, queue-level configuration is only
    # applied where task-level configuration does not exist.
    IF_NOT_EXISTS = 1

    # In the ALWAYS mode, queue-level configuration overrides all
    # task-level configuration
    ALWAYS = 2
  end
end

#scheme ⇒ ::Google::Cloud::Tasks::V2beta3::UriOverride::Scheme

Returns Scheme override.

When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'proto_docs/google/cloud/tasks/v2beta3/target.rb', line 119

class UriOverride
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The Scheme for an HTTP request. By default, it is HTTPS.
  module Scheme
    # Scheme unspecified. Defaults to HTTPS.
    SCHEME_UNSPECIFIED = 0

    # Convert the scheme to HTTP, e.g., https://www.google.ca will change to
    # http://www.google.ca.
    HTTP = 1

    # Convert the scheme to HTTPS, e.g., http://www.google.ca will change to
    # https://www.google.ca.
    HTTPS = 2
  end

  # UriOverrideEnforceMode mode is to define enforcing mode for the override
  # modes.
  module UriOverrideEnforceMode
    # OverrideMode Unspecified. Defaults to ALWAYS.
    URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED = 0

    # In the IF_NOT_EXISTS mode, queue-level configuration is only
    # applied where task-level configuration does not exist.
    IF_NOT_EXISTS = 1

    # In the ALWAYS mode, queue-level configuration overrides all
    # task-level configuration
    ALWAYS = 2
  end
end

#uri_override_enforce_mode ⇒ ::Google::Cloud::Tasks::V2beta3::UriOverride::UriOverrideEnforceMode

Returns URI Override Enforce Mode

When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'proto_docs/google/cloud/tasks/v2beta3/target.rb', line 119

class UriOverride
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The Scheme for an HTTP request. By default, it is HTTPS.
  module Scheme
    # Scheme unspecified. Defaults to HTTPS.
    SCHEME_UNSPECIFIED = 0

    # Convert the scheme to HTTP, e.g., https://www.google.ca will change to
    # http://www.google.ca.
    HTTP = 1

    # Convert the scheme to HTTPS, e.g., http://www.google.ca will change to
    # https://www.google.ca.
    HTTPS = 2
  end

  # UriOverrideEnforceMode mode is to define enforcing mode for the override
  # modes.
  module UriOverrideEnforceMode
    # OverrideMode Unspecified. Defaults to ALWAYS.
    URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED = 0

    # In the IF_NOT_EXISTS mode, queue-level configuration is only
    # applied where task-level configuration does not exist.
    IF_NOT_EXISTS = 1

    # In the ALWAYS mode, queue-level configuration overrides all
    # task-level configuration
    ALWAYS = 2
  end
end