Class UriOverride (2.40.0)

public final class UriOverride extends GeneratedMessageV3 implements UriOverrideOrBuilder

URI Override.

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

Protobuf type google.cloud.tasks.v2beta3.UriOverride

Static Fields

HOST_FIELD_NUMBER

public static final int HOST_FIELD_NUMBER
Field Value
TypeDescription
int

PATH_OVERRIDE_FIELD_NUMBER

public static final int PATH_OVERRIDE_FIELD_NUMBER
Field Value
TypeDescription
int

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_OVERRIDE_FIELD_NUMBER

public static final int QUERY_OVERRIDE_FIELD_NUMBER
Field Value
TypeDescription
int

SCHEME_FIELD_NUMBER

public static final int SCHEME_FIELD_NUMBER
Field Value
TypeDescription
int

URI_OVERRIDE_ENFORCE_MODE_FIELD_NUMBER

public static final int URI_OVERRIDE_ENFORCE_MODE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UriOverride getDefaultInstance()
Returns
TypeDescription
UriOverride

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UriOverride.Builder newBuilder()
Returns
TypeDescription
UriOverride.Builder

newBuilder(UriOverride prototype)

public static UriOverride.Builder newBuilder(UriOverride prototype)
Parameter
NameDescription
prototypeUriOverride
Returns
TypeDescription
UriOverride.Builder

parseDelimitedFrom(InputStream input)

public static UriOverride parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UriOverride parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UriOverride parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UriOverride parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UriOverride parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UriOverride parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UriOverride parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UriOverride parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UriOverride parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UriOverride parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UriOverride parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UriOverride parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UriOverride
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UriOverride> parser()
Returns
TypeDescription
Parser<UriOverride>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public UriOverride getDefaultInstanceForType()
Returns
TypeDescription
UriOverride

getHost()

public String getHost()

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

optional string host = 2;

Returns
TypeDescription
String

The host.

getHostBytes()

public ByteString getHostBytes()

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

optional string host = 2;

Returns
TypeDescription
ByteString

The bytes for host.

getParserForType()

public Parser<UriOverride> getParserForType()
Returns
TypeDescription
Parser<UriOverride>
Overrides

getPathOverride()

public PathOverride getPathOverride()

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.

.google.cloud.tasks.v2beta3.PathOverride path_override = 4;

Returns
TypeDescription
PathOverride

The pathOverride.

getPathOverrideOrBuilder()

public PathOverrideOrBuilder getPathOverrideOrBuilder()

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.

.google.cloud.tasks.v2beta3.PathOverride path_override = 4;

Returns
TypeDescription
PathOverrideOrBuilder

getPort()

public long getPort()

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.

optional int64 port = 3;

Returns
TypeDescription
long

The port.

getQueryOverride()

public QueryOverride getQueryOverride()

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.

.google.cloud.tasks.v2beta3.QueryOverride query_override = 5;

Returns
TypeDescription
QueryOverride

The queryOverride.

getQueryOverrideOrBuilder()

public QueryOverrideOrBuilder getQueryOverrideOrBuilder()

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.

.google.cloud.tasks.v2beta3.QueryOverride query_override = 5;

Returns
TypeDescription
QueryOverrideOrBuilder

getScheme()

public UriOverride.Scheme getScheme()

Scheme override.

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

optional .google.cloud.tasks.v2beta3.UriOverride.Scheme scheme = 1;

Returns
TypeDescription
UriOverride.Scheme

The scheme.

getSchemeValue()

public int getSchemeValue()

Scheme override.

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

optional .google.cloud.tasks.v2beta3.UriOverride.Scheme scheme = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for scheme.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUriOverrideEnforceMode()

public UriOverride.UriOverrideEnforceMode getUriOverrideEnforceMode()

URI Override Enforce Mode

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

.google.cloud.tasks.v2beta3.UriOverride.UriOverrideEnforceMode uri_override_enforce_mode = 6;

Returns
TypeDescription
UriOverride.UriOverrideEnforceMode

The uriOverrideEnforceMode.

getUriOverrideEnforceModeValue()

public int getUriOverrideEnforceModeValue()

URI Override Enforce Mode

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

.google.cloud.tasks.v2beta3.UriOverride.UriOverrideEnforceMode uri_override_enforce_mode = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for uriOverrideEnforceMode.

hasHost()

public boolean hasHost()

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

optional string host = 2;

Returns
TypeDescription
boolean

Whether the host field is set.

hasPathOverride()

public boolean hasPathOverride()

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.

.google.cloud.tasks.v2beta3.PathOverride path_override = 4;

Returns
TypeDescription
boolean

Whether the pathOverride field is set.

hasPort()

public boolean hasPort()

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.

optional int64 port = 3;

Returns
TypeDescription
boolean

Whether the port field is set.

hasQueryOverride()

public boolean hasQueryOverride()

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.

.google.cloud.tasks.v2beta3.QueryOverride query_override = 5;

Returns
TypeDescription
boolean

Whether the queryOverride field is set.

hasScheme()

public boolean hasScheme()

Scheme override.

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

optional .google.cloud.tasks.v2beta3.UriOverride.Scheme scheme = 1;

Returns
TypeDescription
boolean

Whether the scheme field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UriOverride.Builder newBuilderForType()
Returns
TypeDescription
UriOverride.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UriOverride.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UriOverride.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UriOverride.Builder toBuilder()
Returns
TypeDescription
UriOverride.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException