Class: Google::Cloud::NetworkServices::V1::HttpRoute::Redirect

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/networkservices/v1/http_route.rb

Overview

The specification for redirecting traffic.

Defined Under Namespace

Modules: ResponseCode

Instance Attribute Summary collapse

Instance Attribute Details

#host_redirect ⇒ ::String

Returns The host that will be used in the redirect response instead of the one that was supplied in the request.

Returns:

  • (::String) —

    The host that will be used in the redirect response instead of the one that was supplied in the request.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 280

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

  # Supported HTTP response code.
  module ResponseCode
    # Default value
    RESPONSE_CODE_UNSPECIFIED = 0

    # Corresponds to 301.
    MOVED_PERMANENTLY_DEFAULT = 1

    # Corresponds to 302.
    FOUND = 2

    # Corresponds to 303.
    SEE_OTHER = 3

    # Corresponds to 307. In this case, the request method will be retained.
    TEMPORARY_REDIRECT = 4

    # Corresponds to 308. In this case, the request method will be retained.
    PERMANENT_REDIRECT = 5
  end
end

#https_redirect ⇒ ::Boolean

Returns If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

The default is set to false.

Returns:

  • (::Boolean) —

    If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

    The default is set to false.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 280

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

  # Supported HTTP response code.
  module ResponseCode
    # Default value
    RESPONSE_CODE_UNSPECIFIED = 0

    # Corresponds to 301.
    MOVED_PERMANENTLY_DEFAULT = 1

    # Corresponds to 302.
    FOUND = 2

    # Corresponds to 303.
    SEE_OTHER = 3

    # Corresponds to 307. In this case, the request method will be retained.
    TEMPORARY_REDIRECT = 4

    # Corresponds to 308. In this case, the request method will be retained.
    PERMANENT_REDIRECT = 5
  end
end

#path_redirect ⇒ ::String

Returns The path that will be used in the redirect response instead of the one that was supplied in the request. path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

Returns:

  • (::String) —

    The path that will be used in the redirect response instead of the one that was supplied in the request. path_redirect can not be supplied together with prefix_redirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 280

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

  # Supported HTTP response code.
  module ResponseCode
    # Default value
    RESPONSE_CODE_UNSPECIFIED = 0

    # Corresponds to 301.
    MOVED_PERMANENTLY_DEFAULT = 1

    # Corresponds to 302.
    FOUND = 2

    # Corresponds to 303.
    SEE_OTHER = 3

    # Corresponds to 307. In this case, the request method will be retained.
    TEMPORARY_REDIRECT = 4

    # Corresponds to 308. In this case, the request method will be retained.
    PERMANENT_REDIRECT = 5
  end
end

#port_redirect ⇒ ::Integer

Returns The port that will be used in the redirected request instead of the one that was supplied in the request.

Returns:

  • (::Integer) —

    The port that will be used in the redirected request instead of the one that was supplied in the request.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 280

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

  # Supported HTTP response code.
  module ResponseCode
    # Default value
    RESPONSE_CODE_UNSPECIFIED = 0

    # Corresponds to 301.
    MOVED_PERMANENTLY_DEFAULT = 1

    # Corresponds to 302.
    FOUND = 2

    # Corresponds to 303.
    SEE_OTHER = 3

    # Corresponds to 307. In this case, the request method will be retained.
    TEMPORARY_REDIRECT = 4

    # Corresponds to 308. In this case, the request method will be retained.
    PERMANENT_REDIRECT = 5
  end
end

#prefix_rewrite ⇒ ::String

Returns Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request.

Returns:

  • (::String) —

    Indicates that during redirection, the matched prefix (or path) should be swapped with this value. This option allows URLs be dynamically created based on the request.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 280

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

  # Supported HTTP response code.
  module ResponseCode
    # Default value
    RESPONSE_CODE_UNSPECIFIED = 0

    # Corresponds to 301.
    MOVED_PERMANENTLY_DEFAULT = 1

    # Corresponds to 302.
    FOUND = 2

    # Corresponds to 303.
    SEE_OTHER = 3

    # Corresponds to 307. In this case, the request method will be retained.
    TEMPORARY_REDIRECT = 4

    # Corresponds to 308. In this case, the request method will be retained.
    PERMANENT_REDIRECT = 5
  end
end

#response_code ⇒ ::Google::Cloud::NetworkServices::V1::HttpRoute::Redirect::ResponseCode

Returns The HTTP Status code to use for the redirect.

Returns:



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 280

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

  # Supported HTTP response code.
  module ResponseCode
    # Default value
    RESPONSE_CODE_UNSPECIFIED = 0

    # Corresponds to 301.
    MOVED_PERMANENTLY_DEFAULT = 1

    # Corresponds to 302.
    FOUND = 2

    # Corresponds to 303.
    SEE_OTHER = 3

    # Corresponds to 307. In this case, the request method will be retained.
    TEMPORARY_REDIRECT = 4

    # Corresponds to 308. In this case, the request method will be retained.
    PERMANENT_REDIRECT = 5
  end
end

#strip_query ⇒ ::Boolean

Returns if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

The default is set to false.

Returns:

  • (::Boolean) —

    if set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

    The default is set to false.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'proto_docs/google/cloud/networkservices/v1/http_route.rb', line 280

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

  # Supported HTTP response code.
  module ResponseCode
    # Default value
    RESPONSE_CODE_UNSPECIFIED = 0

    # Corresponds to 301.
    MOVED_PERMANENTLY_DEFAULT = 1

    # Corresponds to 302.
    FOUND = 2

    # Corresponds to 303.
    SEE_OTHER = 3

    # Corresponds to 307. In this case, the request method will be retained.
    TEMPORARY_REDIRECT = 4

    # Corresponds to 308. In this case, the request method will be retained.
    PERMANENT_REDIRECT = 5
  end
end