All URIs are relative to http://localhost:2746
| Method | HTTP request | Description |
|---|---|---|
| EventServiceListWorkflowEventBindings | GET /api/v1/workflow-event-bindings/{namespace} | |
| EventServiceReceiveEvent | POST /api/v1/events/{namespace}/{discriminator} |
IoArgoprojWorkflowV1alpha1WorkflowEventBindingList EventServiceListWorkflowEventBindings (string varNamespace, string? listOptionsLabelSelector = null, string? listOptionsFieldSelector = null, bool? listOptionsWatch = null, bool? listOptionsAllowWatchBookmarks = null, string? listOptionsResourceVersion = null, string? listOptionsResourceVersionMatch = null, string? listOptionsTimeoutSeconds = null, string? listOptionsLimit = null, string? listOptionsContinue = null)
using System.Collections.Generic;
using System.Diagnostics;
using ArgoWorkflowsClient.Api;
using ArgoWorkflowsClient.Client;
using ArgoWorkflowsClient.Model;
namespace Example
{
public class EventServiceListWorkflowEventBindingsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "http://localhost:2746";
// Configure API key authorization: BearerToken
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new EventServiceApi(config);
var varNamespace = "varNamespace_example"; // string |
var listOptionsLabelSelector = "listOptionsLabelSelector_example"; // string? | A selector to restrict the list of returned objects by their labels. Defaults to everything. +optional. (optional)
var listOptionsFieldSelector = "listOptionsFieldSelector_example"; // string? | A selector to restrict the list of returned objects by their fields. Defaults to everything. +optional. (optional)
var listOptionsWatch = true; // bool? | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +optional. (optional)
var listOptionsAllowWatchBookmarks = true; // bool? | allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +optional. (optional)
var listOptionsResourceVersion = "listOptionsResourceVersion_example"; // string? | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +optional (optional)
var listOptionsResourceVersionMatch = "listOptionsResourceVersionMatch_example"; // string? | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +optional (optional)
var listOptionsTimeoutSeconds = "listOptionsTimeoutSeconds_example"; // string? | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +optional. (optional)
var listOptionsLimit = "listOptionsLimit_example"; // string? | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
var listOptionsContinue = "listOptionsContinue_example"; // string? | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
try
{
IoArgoprojWorkflowV1alpha1WorkflowEventBindingList result = apiInstance.EventServiceListWorkflowEventBindings(varNamespace, listOptionsLabelSelector, listOptionsFieldSelector, listOptionsWatch, listOptionsAllowWatchBookmarks, listOptionsResourceVersion, listOptionsResourceVersionMatch, listOptionsTimeoutSeconds, listOptionsLimit, listOptionsContinue);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventServiceApi.EventServiceListWorkflowEventBindings: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
ApiResponse<IoArgoprojWorkflowV1alpha1WorkflowEventBindingList> response = apiInstance.EventServiceListWorkflowEventBindingsWithHttpInfo(varNamespace, listOptionsLabelSelector, listOptionsFieldSelector, listOptionsWatch, listOptionsAllowWatchBookmarks, listOptionsResourceVersion, listOptionsResourceVersionMatch, listOptionsTimeoutSeconds, listOptionsLimit, listOptionsContinue);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventServiceApi.EventServiceListWorkflowEventBindingsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|---|---|---|
| varNamespace | string | ||
| listOptionsLabelSelector | string? | A selector to restrict the list of returned objects by their labels. Defaults to everything. +optional. | [optional] |
| listOptionsFieldSelector | string? | A selector to restrict the list of returned objects by their fields. Defaults to everything. +optional. | [optional] |
| listOptionsWatch | bool? | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +optional. | [optional] |
| listOptionsAllowWatchBookmarks | bool? | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +optional. | [optional] |
| listOptionsResourceVersion | string? | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +optional | [optional] |
| listOptionsResourceVersionMatch | string? | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset +optional | [optional] |
| listOptionsTimeoutSeconds | string? | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +optional. | [optional] |
| listOptionsLimit | string? | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| listOptionsContinue | string? | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
IoArgoprojWorkflowV1alpha1WorkflowEventBindingList
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Object EventServiceReceiveEvent (string varNamespace, string discriminator, Object body)
using System.Collections.Generic;
using System.Diagnostics;
using ArgoWorkflowsClient.Api;
using ArgoWorkflowsClient.Client;
using ArgoWorkflowsClient.Model;
namespace Example
{
public class EventServiceReceiveEventExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "http://localhost:2746";
// Configure API key authorization: BearerToken
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new EventServiceApi(config);
var varNamespace = "varNamespace_example"; // string | The namespace for the io.argoproj.workflow.v1alpha1. This can be empty if the client has cluster scoped permissions. If empty, then the event is \"broadcast\" to workflow event binding in all namespaces.
var discriminator = "discriminator_example"; // string | Optional discriminator for the io.argoproj.workflow.v1alpha1. This should almost always be empty. Used for edge-cases where the event payload alone is not provide enough information to discriminate the event. This MUST NOT be used as security mechanism, e.g. to allow two clients to use the same access token, or to support webhooks on unsecured server. Instead, use access tokens. This is made available as `discriminator` in the event binding selector (`/spec/event/selector)`
var body = null; // Object | The event itself can be any data.
try
{
Object result = apiInstance.EventServiceReceiveEvent(varNamespace, discriminator, body);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventServiceApi.EventServiceReceiveEvent: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}This returns an ApiResponse object which contains the response data, status code and headers.
try
{
ApiResponse<Object> response = apiInstance.EventServiceReceiveEventWithHttpInfo(varNamespace, discriminator, body);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventServiceApi.EventServiceReceiveEventWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}| Name | Type | Description | Notes |
|---|---|---|---|
| varNamespace | string | The namespace for the io.argoproj.workflow.v1alpha1. This can be empty if the client has cluster scoped permissions. If empty, then the event is "broadcast" to workflow event binding in all namespaces. | |
| discriminator | string | Optional discriminator for the io.argoproj.workflow.v1alpha1. This should almost always be empty. Used for edge-cases where the event payload alone is not provide enough information to discriminate the event. This MUST NOT be used as security mechanism, e.g. to allow two clients to use the same access token, or to support webhooks on unsecured server. Instead, use access tokens. This is made available as `discriminator` in the event binding selector (`/spec/event/selector)` | |
| body | Object | The event itself can be any data. |
Object
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A successful response. | - |
| 0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]