Endpoint class
Source or destination of the Connectivity Test.
- Inheritance
-
- Object
- GeneratedMessage
- Endpoint
Constructors
- Endpoint({String? ipAddress, int? port, String? instance, String? network, Endpoint_NetworkType? networkType, String? projectId, String? gkeMasterCluster, String? cloudSqlInstance, Endpoint_CloudFunctionEndpoint? cloudFunction, Endpoint_AppEngineVersionEndpoint? appEngineVersion, Endpoint_CloudRunRevisionEndpoint? cloudRunRevision})
-
factory
-
Endpoint.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- Endpoint.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- appEngineVersion ↔ Endpoint_AppEngineVersionEndpoint
-
An App Engine service
version.
getter/setter pair
- cloudFunction ↔ Endpoint_CloudFunctionEndpoint
-
A Cloud Function.
getter/setter pair
- cloudRunRevision ↔ Endpoint_CloudRunRevisionEndpoint
-
A Cloud Run
revision
getter/setter pair
- cloudSqlInstance ↔ String
-
A Cloud SQL instance URI.
getter/setter pair
- eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
- gkeMasterCluster ↔ String
-
A cluster URI for Google Kubernetes Engine
master.
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setteroverride
- instance ↔ String
-
A Compute Engine instance URI.
getter/setter pair
- ipAddress ↔ String
-
The IP address of the endpoint, which can be an external or internal IP.
An IPv6 address is only allowed when the test's destination is a
global load balancer VIP.
getter/setter pair
- isFrozen → bool
-
Returns
true
if this message is marked read-only. Otherwisefalse
.no setterinherited - network ↔ String
-
A Compute Engine network URI.
getter/setter pair
- networkType ↔ Endpoint_NetworkType
-
Type of the network where the endpoint is located.
Applicable only to source endpoint, as destination network type can be
inferred from the source.
getter/setter pair
- port ↔ int
-
The IP protocol port of the endpoint.
Only applicable when protocol is TCP or UDP.
getter/setter pair
- projectId ↔ String
-
Project ID where the endpoint is located.
The Project ID can be derived from the URI if you provide a VM instance or
network URI.
The following are two cases where you must provide the project ID:
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- unknownFields → UnknownFieldSet
-
no setterinherited
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearAppEngineVersion(
) → void -
clearCloudFunction(
) → void -
clearCloudRunRevision(
) → void -
clearCloudSqlInstance(
) → 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
-
clearGkeMasterCluster(
) → void -
clearInstance(
) → void -
clearIpAddress(
) → void -
clearNetwork(
) → void -
clearNetworkType(
) → void -
clearPort(
) → void -
clearProjectId(
) → void -
clone(
) → Endpoint -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(Endpoint)) → Endpoint -
Apply
updates
to a copy of this message.override -
createEmptyInstance(
) → Endpoint -
Creates an empty instance of the same message type as this.
override
-
createMapField<
K, V> (int tagNumber, MapFieldInfo< K, V> fi) → Map<K, V> -
Creates a Map representing a map field.
inherited
-
createRepeatedField<
T> (int tagNumber, FieldInfo< T> fi) → List<T> -
Creates List implementing a mutable repeated field.
inherited
-
ensureAppEngineVersion(
) → Endpoint_AppEngineVersionEndpoint -
ensureCloudFunction(
) → Endpoint_CloudFunctionEndpoint -
ensureCloudRunRevision(
) → Endpoint_CloudRunRevisionEndpoint -
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
-
hasAppEngineVersion(
) → bool -
hasCloudFunction(
) → bool -
hasCloudRunRevision(
) → bool -
hasCloudSqlInstance(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
true
if a value ofextension
is present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber
.inherited -
hasGkeMasterCluster(
) → bool -
hasInstance(
) → bool -
hasIpAddress(
) → bool -
hasNetwork(
) → bool -
hasNetworkType(
) → bool -
hasPort(
) → bool -
hasProjectId(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
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 -
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
other
into 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 -
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
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(
) → Endpoint -
createRepeated(
) → PbList< Endpoint> -
getDefault(
) → Endpoint