Target class
- Available extensions
Constructors
- Target({String? id, Timestamp? creationDate, Timestamp? changeDate, String? name, RESTWebhook? restWebhook, RESTCall? restCall, RESTAsync? restAsync, Duration? timeout, String? endpoint, String? signingKey, PayloadType? payloadType})
-
factory
-
Target.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- Target.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- changeDate ↔ Timestamp
-
The timestamp of the last change to the target.
getter/setter pair
- creationDate ↔ Timestamp
-
The timestamp of the target creation.
getter/setter pair
- endpoint ↔ String
-
The URL that will be called in case of an execution.
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- id ↔ String
-
The unique identifier of the target.
getter/setter pair
- info_ → BuilderInfo
-
no setter
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - name ↔ String
-
Display name of the target.
getter/setter pair
- payloadType ↔ PayloadType
-
Payload type defines how the payload is formatted and secured.
The default is
PAYLOAD_TYPE_JSON, which sends the payload as JSON in the body of the request. For integrity and authenticity a signature is included in the headerX-ZITADEL-Signature. You can also choose to send the payload as a JWT (PAYLOAD_TYPE_JWT), which sends the payload as a signed JWT in the body of the request. This allows the receiver to verify the authenticity and integrity of the payload using the signing key (published on the JWKS URL). If you need encryption as well, you can choosePAYLOAD_TYPE_JWE, which sends the payload as an encrypted JWT in the body of the request. You can provide your own public key for encryption.getter/setter pair - restAsync ↔ RESTAsync
-
getter/setter pair
- restCall ↔ RESTCall
-
getter/setter pair
- restWebhook ↔ RESTWebhook
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- signingKey ↔ String
-
The current signing key used to sign the request sent to the target.
The key can be used to verify the integrity and authenticity of the request
on the receiver side. The key should be treated as a secret and only known to ZITADEL and the receiver.
The signature is included in the request header
X-ZITADEL-Signatureand calculated over the raw body of the request using HMAC with SHA256.getter/setter pair - timeout ↔ Duration
-
Timeout defines the duration until ZITADEL cancels the execution.
If the target doesn't respond before this timeout expires, the the connection is closed and the action fails. Depending on the target type and possible setting on
interrupt_on_errorfollowing targets will not be called. In case of arest_asynctarget only this specific target will fail, without any influence on other targets of the same execution.getter/setter pair - unknownFields → UnknownFieldSet
-
no setterinherited
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
-
clearChangeDate(
) → void -
clearCreationDate(
) → void -
clearEndpoint(
) → 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
-
clearId(
) → void -
clearName(
) → void -
clearPayloadType(
) → void -
clearRestAsync(
) → void -
clearRestCall(
) → void -
clearRestWebhook(
) → void -
clearSigningKey(
) → void -
clearTargetType(
) → void -
clearTimeout(
) → void -
clone(
) → Target - Creates a deep copy of the fields in this message.
-
copyWith(
void updates(Target)) → Target -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → Target - Creates an empty instance of the same message type as this.
-
deepCopy(
) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Returns a writable deep copy of this message. -
ensureChangeDate(
) → Timestamp -
ensureCreationDate(
) → Timestamp -
ensureRestAsync(
) → RESTAsync -
ensureRestCall(
) → RESTCall -
ensureRestWebhook(
) → RESTWebhook -
ensureTimeout(
) → Duration -
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
-
hasChangeDate(
) → bool -
hasCreationDate(
) → bool -
hasEndpoint(
) → 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 -
hasId(
) → bool -
hasName(
) → bool -
hasPayloadType(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasRestAsync(
) → bool -
hasRestCall(
) → bool -
hasRestWebhook(
) → bool -
hasSigningKey(
) → bool -
hasTimeout(
) → 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
-
rebuild(
void updates(T)) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Applyupdatesto a copy of this message. -
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
-
whichTargetType(
) → Target_TargetType -
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(
) → Target -
getDefault(
) → Target