SystemServiceClient class
- Annotations
-
- @GrpcServiceName.new('zitadel.system.v1.SystemService')
Properties
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
$createCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options})
→ ClientCall<Q, R>
-
inherited
-
$createStreamingCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options})
→ ResponseStream<R>
-
inherited
-
$createUnaryCall<Q, R>(ClientMethod<Q, R> method, Q request, {CallOptions? options})
→ ResponseFuture<R>
-
inherited
-
addDomain(AddDomainRequest request, {CallOptions? options})
→ ResponseFuture<AddDomainResponse>
-
Adds a domain to an instance
-
addInstance(AddInstanceRequest request, {CallOptions? options})
→ ResponseFuture<AddInstanceResponse>
-
Deprecated: Use CreateInstance instead
Creates a new instance with all needed setup data
This might take some time
-
addQuota(AddQuotaRequest request, {CallOptions? options})
→ ResponseFuture<AddQuotaResponse>
-
Creates a new quota
Returns an error if the quota already exists for the specified unit
Deprecated: use SetQuota instead
-
bulkSetLimits(BulkSetLimitsRequest request, {CallOptions? options})
→ ResponseFuture<BulkSetLimitsResponse>
-
Sets many instance level limits
-
clearView(ClearViewRequest request, {CallOptions? options})
→ ResponseFuture<ClearViewResponse>
-
Truncates the delta of the change stream
be carefull with this function because ZITADEL has to
recompute the deltas after they got cleared.
Search requests will return wrong results until all deltas are recomputed
-
createInstance(CreateInstanceRequest request, {CallOptions? options})
→ ResponseFuture<CreateInstanceResponse>
-
Creates a new instance with all needed setup data
This might take some time
-
existsDomain(ExistsDomainRequest request, {CallOptions? options})
→ ResponseFuture<ExistsDomainResponse>
-
Checks if a domain exists
-
getInstance(GetInstanceRequest request, {CallOptions? options})
→ ResponseFuture<GetInstanceResponse>
-
Returns the detail of an instance
-
healthz(HealthzRequest request, {CallOptions? options})
→ ResponseFuture<HealthzResponse>
-
Indicates if ZITADEL is running.
It respondes as soon as ZITADEL started
-
listDomains(ListDomainsRequest request, {CallOptions? options})
→ ResponseFuture<ListDomainsResponse>
-
List Domains
-
listFailedEvents(ListFailedEventsRequest request, {CallOptions? options})
→ ResponseFuture<ListFailedEventsResponse>
-
Returns event descriptions which cannot be processed.
It's possible that some events need some retries.
For example if the SMTP-API wasn't able to send an email at the first time
-
listIAMMembers(ListIAMMembersRequest request, {CallOptions? options})
→ ResponseFuture<ListIAMMembersResponse>
-
Returns all instance members matching the request
all queries need to match (ANDed)
Deprecated: Use the Admin APIs ListIAMMembers instead
-
listInstances(ListInstancesRequest request, {CallOptions? options})
→ ResponseFuture<ListInstancesResponse>
-
Returns a list of ZITADEL instances
-
listViews(ListViewsRequest request, {CallOptions? options})
→ ResponseFuture<ListViewsResponse>
-
Returns all stored read models of ZITADEL
views are used for search optimisation and optimise request latencies
they represent the delta of the event happend on the objects
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
removeDomain(RemoveDomainRequest request, {CallOptions? options})
→ ResponseFuture<RemoveDomainResponse>
-
Removes the domain of an instance
-
removeFailedEvent(RemoveFailedEventRequest request, {CallOptions? options})
→ ResponseFuture<RemoveFailedEventResponse>
-
Deletes the event from failed events view.
the event is not removed from the change stream
This call is usefull if the system was able to process the event later.
e.g. if the second try of sending an email was successful. the first try produced a
failed event. You can find out if it worked on the
failure_count
-
removeInstance(RemoveInstanceRequest request, {CallOptions? options})
→ ResponseFuture<RemoveInstanceResponse>
-
Removes an instance
This might take some time
-
removeQuota(RemoveQuotaRequest request, {CallOptions? options})
→ ResponseFuture<RemoveQuotaResponse>
-
Removes a quota
-
resetLimits(ResetLimitsRequest request, {CallOptions? options})
→ ResponseFuture<ResetLimitsResponse>
-
Resets instance level limits
-
setInstanceFeature(SetInstanceFeatureRequest request, {CallOptions? options})
→ ResponseFuture<SetInstanceFeatureResponse>
-
Set a feature flag on an instance
-
setLimits(SetLimitsRequest request, {CallOptions? options})
→ ResponseFuture<SetLimitsResponse>
-
Sets instance level limits
-
setPrimaryDomain(SetPrimaryDomainRequest request, {CallOptions? options})
→ ResponseFuture<SetPrimaryDomainResponse>
-
Sets the primary domain of an instance
-
setQuota(SetQuotaRequest request, {CallOptions? options})
→ ResponseFuture<SetQuotaResponse>
-
Sets quota configuration properties
Creates a new quota if it doesn't exist for the specified unit
-
toString()
→ String
-
A string representation of this object.
inherited
-
updateInstance(UpdateInstanceRequest request, {CallOptions? options})
→ ResponseFuture<UpdateInstanceResponse>
-
Updates name of an existing instance
