Class AuthorizationPolicy.Rule.Destination.Builder (0.45.0)

public static final class AuthorizationPolicy.Rule.Destination.Builder extends GeneratedMessageV3.Builder<AuthorizationPolicy.Rule.Destination.Builder> implements AuthorizationPolicy.Rule.DestinationOrBuilder

Specification of traffic destination attributes.

Protobuf type google.cloud.networksecurity.v1.AuthorizationPolicy.Rule.Destination

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllHosts(Iterable<String> values)

public AuthorizationPolicy.Rule.Destination.Builder addAllHosts(Iterable<String> values)

Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.") or a suffix match (example ".myorg.com") or a presence (any) match "*".

repeated string hosts = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<String>

The hosts to add.

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

addAllMethods(Iterable<String> values)

public AuthorizationPolicy.Rule.Destination.Builder addAllMethods(Iterable<String> values)

Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.

repeated string methods = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The methods to add.

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

addAllPorts(Iterable<? extends Integer> values)

public AuthorizationPolicy.Rule.Destination.Builder addAllPorts(Iterable<? extends Integer> values)

Required. List of destination ports to match. At least one port should match.

repeated uint32 ports = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends java.lang.Integer>

The ports to add.

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

addHosts(String value)

public AuthorizationPolicy.Rule.Destination.Builder addHosts(String value)

Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.") or a suffix match (example ".myorg.com") or a presence (any) match "*".

repeated string hosts = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The hosts to add.

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

addHostsBytes(ByteString value)

public AuthorizationPolicy.Rule.Destination.Builder addHostsBytes(ByteString value)

Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.") or a suffix match (example ".myorg.com") or a presence (any) match "*".

repeated string hosts = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes of the hosts to add.

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

addMethods(String value)

public AuthorizationPolicy.Rule.Destination.Builder addMethods(String value)

Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.

repeated string methods = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The methods to add.

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

addMethodsBytes(ByteString value)

public AuthorizationPolicy.Rule.Destination.Builder addMethodsBytes(ByteString value)

Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.

repeated string methods = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the methods to add.

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

addPorts(int value)

public AuthorizationPolicy.Rule.Destination.Builder addPorts(int value)

Required. List of destination ports to match. At least one port should match.

repeated uint32 ports = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The ports to add.

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AuthorizationPolicy.Rule.Destination.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder
Overrides

build()

public AuthorizationPolicy.Rule.Destination build()
Returns
Type Description
AuthorizationPolicy.Rule.Destination

buildPartial()

public AuthorizationPolicy.Rule.Destination buildPartial()
Returns
Type Description
AuthorizationPolicy.Rule.Destination

clear()

public AuthorizationPolicy.Rule.Destination.Builder clear()
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AuthorizationPolicy.Rule.Destination.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder
Overrides

clearHosts()

public AuthorizationPolicy.Rule.Destination.Builder clearHosts()

Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.") or a suffix match (example ".myorg.com") or a presence (any) match "*".

repeated string hosts = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

clearHttpHeaderMatch()

public AuthorizationPolicy.Rule.Destination.Builder clearHttpHeaderMatch()

Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy.

.google.cloud.networksecurity.v1.AuthorizationPolicy.Rule.Destination.HttpHeaderMatch http_header_match = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

clearMethods()

public AuthorizationPolicy.Rule.Destination.Builder clearMethods()

Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.

repeated string methods = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AuthorizationPolicy.Rule.Destination.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder
Overrides

clearPorts()

public AuthorizationPolicy.Rule.Destination.Builder clearPorts()

Required. List of destination ports to match. At least one port should match.

repeated uint32 ports = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

clone()

public AuthorizationPolicy.Rule.Destination.Builder clone()
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder
Overrides

getDefaultInstanceForType()

public AuthorizationPolicy.Rule.Destination getDefaultInstanceForType()
Returns
Type Description
AuthorizationPolicy.Rule.Destination

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHosts(int index)

public String getHosts(int index)

Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.") or a suffix match (example ".myorg.com") or a presence (any) match "*".

repeated string hosts = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The hosts at the given index.

getHostsBytes(int index)

public ByteString getHostsBytes(int index)

Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.") or a suffix match (example ".myorg.com") or a presence (any) match "*".

repeated string hosts = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the hosts at the given index.

getHostsCount()

public int getHostsCount()

Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.") or a suffix match (example ".myorg.com") or a presence (any) match "*".

repeated string hosts = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of hosts.

getHostsList()

public ProtocolStringList getHostsList()

Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.") or a suffix match (example ".myorg.com") or a presence (any) match "*".

repeated string hosts = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the hosts.

getHttpHeaderMatch()

public AuthorizationPolicy.Rule.Destination.HttpHeaderMatch getHttpHeaderMatch()

Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy.

.google.cloud.networksecurity.v1.AuthorizationPolicy.Rule.Destination.HttpHeaderMatch http_header_match = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AuthorizationPolicy.Rule.Destination.HttpHeaderMatch

The httpHeaderMatch.

getHttpHeaderMatchBuilder()

public AuthorizationPolicy.Rule.Destination.HttpHeaderMatch.Builder getHttpHeaderMatchBuilder()

Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy.

.google.cloud.networksecurity.v1.AuthorizationPolicy.Rule.Destination.HttpHeaderMatch http_header_match = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AuthorizationPolicy.Rule.Destination.HttpHeaderMatch.Builder

getHttpHeaderMatchOrBuilder()

public AuthorizationPolicy.Rule.Destination.HttpHeaderMatchOrBuilder getHttpHeaderMatchOrBuilder()

Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy.

.google.cloud.networksecurity.v1.AuthorizationPolicy.Rule.Destination.HttpHeaderMatch http_header_match = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AuthorizationPolicy.Rule.Destination.HttpHeaderMatchOrBuilder

getMethods(int index)

public String getMethods(int index)

Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.

repeated string methods = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The methods at the given index.

getMethodsBytes(int index)

public ByteString getMethodsBytes(int index)

Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.

repeated string methods = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the methods at the given index.

getMethodsCount()

public int getMethodsCount()

Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.

repeated string methods = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of methods.

getMethodsList()

public ProtocolStringList getMethodsList()

Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.

repeated string methods = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the methods.

getPorts(int index)

public int getPorts(int index)

Required. List of destination ports to match. At least one port should match.

repeated uint32 ports = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
int

The ports at the given index.

getPortsCount()

public int getPortsCount()

Required. List of destination ports to match. At least one port should match.

repeated uint32 ports = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of ports.

getPortsList()

public List<Integer> getPortsList()

Required. List of destination ports to match. At least one port should match.

repeated uint32 ports = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Integer>

A list containing the ports.

hasHttpHeaderMatch()

public boolean hasHttpHeaderMatch()

Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy.

.google.cloud.networksecurity.v1.AuthorizationPolicy.Rule.Destination.HttpHeaderMatch http_header_match = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the httpHeaderMatch field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AuthorizationPolicy.Rule.Destination other)

public AuthorizationPolicy.Rule.Destination.Builder mergeFrom(AuthorizationPolicy.Rule.Destination other)
Parameter
Name Description
other AuthorizationPolicy.Rule.Destination
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AuthorizationPolicy.Rule.Destination.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AuthorizationPolicy.Rule.Destination.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder
Overrides

mergeHttpHeaderMatch(AuthorizationPolicy.Rule.Destination.HttpHeaderMatch value)

public AuthorizationPolicy.Rule.Destination.Builder mergeHttpHeaderMatch(AuthorizationPolicy.Rule.Destination.HttpHeaderMatch value)

Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy.

.google.cloud.networksecurity.v1.AuthorizationPolicy.Rule.Destination.HttpHeaderMatch http_header_match = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AuthorizationPolicy.Rule.Destination.HttpHeaderMatch
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AuthorizationPolicy.Rule.Destination.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public AuthorizationPolicy.Rule.Destination.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder
Overrides

setHosts(int index, String value)

public AuthorizationPolicy.Rule.Destination.Builder setHosts(int index, String value)

Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.") or a suffix match (example ".myorg.com") or a presence (any) match "*".

repeated string hosts = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int

The index to set the value at.

value String

The hosts to set.

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

setHttpHeaderMatch(AuthorizationPolicy.Rule.Destination.HttpHeaderMatch value)

public AuthorizationPolicy.Rule.Destination.Builder setHttpHeaderMatch(AuthorizationPolicy.Rule.Destination.HttpHeaderMatch value)

Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy.

.google.cloud.networksecurity.v1.AuthorizationPolicy.Rule.Destination.HttpHeaderMatch http_header_match = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AuthorizationPolicy.Rule.Destination.HttpHeaderMatch
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

setHttpHeaderMatch(AuthorizationPolicy.Rule.Destination.HttpHeaderMatch.Builder builderForValue)

public AuthorizationPolicy.Rule.Destination.Builder setHttpHeaderMatch(AuthorizationPolicy.Rule.Destination.HttpHeaderMatch.Builder builderForValue)

Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy.

.google.cloud.networksecurity.v1.AuthorizationPolicy.Rule.Destination.HttpHeaderMatch http_header_match = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AuthorizationPolicy.Rule.Destination.HttpHeaderMatch.Builder
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

setMethods(int index, String value)

public AuthorizationPolicy.Rule.Destination.Builder setMethods(int index, String value)

Optional. A list of HTTP methods to match. At least one method should match. Should not be set for gRPC services.

repeated string methods = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The methods to set.

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

setPorts(int index, int value)

public AuthorizationPolicy.Rule.Destination.Builder setPorts(int index, int value)

Required. List of destination ports to match. At least one port should match.

repeated uint32 ports = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int

The index to set the value at.

value int

The ports to set.

Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AuthorizationPolicy.Rule.Destination.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AuthorizationPolicy.Rule.Destination.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AuthorizationPolicy.Rule.Destination.Builder
Overrides