EndpointPolicy class
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.
Constructors
-
EndpointPolicy({String? name, Timestamp? createTime, Timestamp? updateTime, Map<
String, String> ? labels, EndpointPolicy_EndpointPolicyType? type, String? authorizationPolicy, EndpointMatcher? endpointMatcher, TrafficPortSelector? trafficPortSelector, String? description, String? serverTlsPolicy, String? clientTlsPolicy}) -
factory
-
EndpointPolicy.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- EndpointPolicy.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
-
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.
getter/setter pair
- clientTlsPolicy ↔ String
-
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.
getter/setter pair
- createTime ↔ Timestamp
-
Output only. The timestamp when the resource was created.
getter/setter pair
- description ↔ String
-
Optional. A free-text description of the resource. Max length 1024
characters.
getter/setter pair
- endpointMatcher ↔ EndpointMatcher
-
Required. A matcher that selects endpoints to which the policies should be
applied.
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setter
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited -
labels
→ Map<
String, String> -
Optional. Set of label tags associated with the EndpointPolicy resource.
no setter
- name ↔ String
-
Required. Name of the EndpointPolicy resource. It matches pattern
projects/{project}/locations/global/endpointPolicies/{endpoint_policy}.getter/setter pair - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serverTlsPolicy ↔ String
-
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.
getter/setter pair
- trafficPortSelector ↔ TrafficPortSelector
-
Optional. Port selector for the (matched) endpoints. If no port selector is
provided, the matched config is applied to all ports.
getter/setter pair
- type ↔ EndpointPolicy_EndpointPolicyType
-
Required. The type of endpoint policy. This is primarily used to validate
the configuration.
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
- updateTime ↔ Timestamp
-
Output only. The timestamp when the resource was updated.
getter/setter pair
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
Throws a StateError if the message has required fields without a value.
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearAuthorizationPolicy(
) → void -
clearClientTlsPolicy(
) → void -
clearCreateTime(
) → void -
clearDescription(
) → void -
clearEndpointMatcher(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearName(
) → void -
clearServerTlsPolicy(
) → void -
clearTrafficPortSelector(
) → void -
clearType(
) → void -
clearUpdateTime(
) → void -
clone(
) → EndpointPolicy - Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
-
copyWith(
void updates(EndpointPolicy)) → EndpointPolicy -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → EndpointPolicy - Creates an empty instance of the same message type as this.
-
ensureCreateTime(
) → Timestamp -
ensureEndpointMatcher(
) → EndpointMatcher -
ensureTrafficPortSelector(
) → TrafficPortSelector -
ensureUpdateTime(
) → Timestamp -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasAuthorizationPolicy(
) → bool -
hasClientTlsPolicy(
) → bool -
hasCreateTime(
) → bool -
hasDescription(
) → bool -
hasEndpointMatcher(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasName(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasServerTlsPolicy(
) → bool -
hasTrafficPortSelector(
) → bool -
hasType(
) → bool -
hasUpdateTime(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Same as
mergeFromBuffer, but takes aCodedBufferReaderinput.inherited -
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
writeToBuffer(
) → Uint8List -
Serialize the message as the protobuf binary format.
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
Same as
writeToBuffer, but serializes to the givenCodedBufferWriter.inherited -
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → EndpointPolicy -
createRepeated(
) → PbList< EndpointPolicy> -
getDefault(
) → EndpointPolicy