public final class EndpointPolicy extends GeneratedMessageV3 implements EndpointPolicyOrBuilder
EndpointPolicy is a resource that helps apply desired configuration
on the endpoints that match specific criteria.
For example, this resource can be used to apply "authentication config"
an all endpoints that serve on port 8080.
Protobuf type google.cloud.networkservices.v1.EndpointPolicy
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AUTHORIZATION_POLICY_FIELD_NUMBER
public static final int AUTHORIZATION_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLIENT_TLS_POLICY_FIELD_NUMBER
public static final int CLIENT_TLS_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENDPOINT_MATCHER_FIELD_NUMBER
public static final int ENDPOINT_MATCHER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SERVER_TLS_POLICY_FIELD_NUMBER
public static final int SERVER_TLS_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TRAFFIC_PORT_SELECTOR_FIELD_NUMBER
public static final int TRAFFIC_PORT_SELECTOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static EndpointPolicy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static EndpointPolicy.Builder newBuilder()
newBuilder(EndpointPolicy prototype)
public static EndpointPolicy.Builder newBuilder(EndpointPolicy prototype)
public static EndpointPolicy parseDelimitedFrom(InputStream input)
public static EndpointPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static EndpointPolicy parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EndpointPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static EndpointPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EndpointPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EndpointPolicy parseFrom(CodedInputStream input)
public static EndpointPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EndpointPolicy parseFrom(InputStream input)
public static EndpointPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static EndpointPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EndpointPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<EndpointPolicy> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Optional. Set of label tags associated with the EndpointPolicy resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAuthorizationPolicy()
public String getAuthorizationPolicy()
Optional. This field specifies the URL of AuthorizationPolicy resource that
applies authorization policies to the inbound traffic at the
matched endpoints. Refer to Authorization. If this field is not
specified, authorization is disabled(no authz checks) for this
endpoint.
string authorization_policy = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The authorizationPolicy.
|
getAuthorizationPolicyBytes()
public ByteString getAuthorizationPolicyBytes()
Optional. This field specifies the URL of AuthorizationPolicy resource that
applies authorization policies to the inbound traffic at the
matched endpoints. Refer to Authorization. If this field is not
specified, authorization is disabled(no authz checks) for this
endpoint.
string authorization_policy = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for authorizationPolicy.
|
getClientTlsPolicy()
public String getClientTlsPolicy()
Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy
can be set to specify the authentication for traffic from the proxy to the
actual endpoints. More specifically, it is applied to the outgoing traffic
from the proxy to the endpoint. This is typically used for sidecar model
where the proxy identifies itself as endpoint to the control plane, with
the connection between sidecar and endpoint requiring authentication. If
this field is not set, authentication is disabled(open). Applicable only
when EndpointPolicyType is SIDECAR_PROXY.
string client_tls_policy = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The clientTlsPolicy.
|
getClientTlsPolicyBytes()
public ByteString getClientTlsPolicyBytes()
Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy
can be set to specify the authentication for traffic from the proxy to the
actual endpoints. More specifically, it is applied to the outgoing traffic
from the proxy to the endpoint. This is typically used for sidecar model
where the proxy identifies itself as endpoint to the control plane, with
the connection between sidecar and endpoint requiring authentication. If
this field is not set, authentication is disabled(open). Applicable only
when EndpointPolicyType is SIDECAR_PROXY.
string client_tls_policy = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for clientTlsPolicy.
|
getCreateTime()
public Timestamp getCreateTime()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public EndpointPolicy getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. A free-text description of the resource. Max length 1024
characters.
string description = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. A free-text description of the resource. Max length 1024
characters.
string description = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getEndpointMatcher()
public EndpointMatcher getEndpointMatcher()
Required. A matcher that selects endpoints to which the policies should be
applied.
.google.cloud.networkservices.v1.EndpointMatcher endpoint_matcher = 9 [(.google.api.field_behavior) = REQUIRED];
getEndpointMatcherOrBuilder()
public EndpointMatcherOrBuilder getEndpointMatcherOrBuilder()
Required. A matcher that selects endpoints to which the policies should be
applied.
.google.cloud.networkservices.v1.EndpointMatcher endpoint_matcher = 9 [(.google.api.field_behavior) = REQUIRED];
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Optional. Set of label tags associated with the EndpointPolicy resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. Set of label tags associated with the EndpointPolicy resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. Set of label tags associated with the EndpointPolicy resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. Set of label tags associated with the EndpointPolicy resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getName()
Required. Name of the EndpointPolicy resource. It matches pattern
projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. Name of the EndpointPolicy resource. It matches pattern
projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<EndpointPolicy> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getServerTlsPolicy()
public String getServerTlsPolicy()
Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is
used to determine the authentication policy to be applied to terminate the
inbound traffic at the identified backends. If this field is not set,
authentication is disabled(open) for this endpoint.
string server_tls_policy = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The serverTlsPolicy.
|
getServerTlsPolicyBytes()
public ByteString getServerTlsPolicyBytes()
Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is
used to determine the authentication policy to be applied to terminate the
inbound traffic at the identified backends. If this field is not set,
authentication is disabled(open) for this endpoint.
string server_tls_policy = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for serverTlsPolicy.
|
getTrafficPortSelector()
public TrafficPortSelector getTrafficPortSelector()
Optional. Port selector for the (matched) endpoints. If no port selector is
provided, the matched config is applied to all ports.
.google.cloud.networkservices.v1.TrafficPortSelector traffic_port_selector = 10 [(.google.api.field_behavior) = OPTIONAL];
getTrafficPortSelectorOrBuilder()
public TrafficPortSelectorOrBuilder getTrafficPortSelectorOrBuilder()
Optional. Port selector for the (matched) endpoints. If no port selector is
provided, the matched config is applied to all ports.
.google.cloud.networkservices.v1.TrafficPortSelector traffic_port_selector = 10 [(.google.api.field_behavior) = OPTIONAL];
getType()
public EndpointPolicy.EndpointPolicyType getType()
Required. The type of endpoint policy. This is primarily used to validate
the configuration.
.google.cloud.networkservices.v1.EndpointPolicy.EndpointPolicyType type = 5 [(.google.api.field_behavior) = REQUIRED];
getTypeValue()
public int getTypeValue()
Required. The type of endpoint policy. This is primarily used to validate
the configuration.
.google.cloud.networkservices.v1.EndpointPolicy.EndpointPolicyType type = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for type.
|
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasEndpointMatcher()
public boolean hasEndpointMatcher()
Required. A matcher that selects endpoints to which the policies should be
applied.
.google.cloud.networkservices.v1.EndpointMatcher endpoint_matcher = 9 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the endpointMatcher field is set.
|
hasTrafficPortSelector()
public boolean hasTrafficPortSelector()
Optional. Port selector for the (matched) endpoints. If no port selector is
provided, the matched config is applied to all ports.
.google.cloud.networkservices.v1.TrafficPortSelector traffic_port_selector = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the trafficPortSelector field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public EndpointPolicy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EndpointPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public EndpointPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
