\AlertWatchersAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
AlertWatchersDelete	Delete /api/2.56/alert-watchers	Delete alert watcher
AlertWatchersGet	Get /api/2.56/alert-watchers	List alert watchers
AlertWatchersPatch	Patch /api/2.56/alert-watchers	Modify alert watcher
AlertWatchersPost	Post /api/2.56/alert-watchers	Create alert watcher
AlertWatchersTestGet	Get /api/2.56/alert-watchers/test	List alert watcher test

AlertWatchersDelete

AlertWatchersDelete(ctx).Names(names).Authorization(authorization).XRequestID(xRequestID).Execute()

Delete alert watcher

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)

func main() {
    configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
        APIToken(apiToken).
        Build()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
    }
    apiClient, err := openapiclient.NewClient(configuration)
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
    }
    req := apiClient.AlertWatchersAPI.AlertWatchersDelete(context.Background())
    // Set request parameters ...

    resp, r, err := req.Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AlertWatchersAPI.AlertWatchersDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiAlertWatchersDeleteRequest struct via the builder pattern

Name	Type	Description
names	[]string	Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format.
authorization	string	Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
xRequestID	string	Supplied by client during request or generated by server.

Return type

(empty response body)

Authorization

Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AlertWatchersGet

AlertWatcherGetResponse AlertWatchersGet(ctx).Authorization(authorization).XRequestID(xRequestID).ContinuationToken(continuationToken).Filter(filter).Limit(limit).Names(names).Offset(offset).Sort(sort).TotalItemCount(totalItemCount).Execute()

List alert watchers

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)

func main() {
    configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
        APIToken(apiToken).
        Build()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
    }
    apiClient, err := openapiclient.NewClient(configuration)
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
    }
    req := apiClient.AlertWatchersAPI.AlertWatchersGet(context.Background())
    // Set request parameters ...

    resp, r, err := req.Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AlertWatchersAPI.AlertWatchersGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AlertWatchersGet`: AlertWatcherGetResponse
    fmt.Fprintf(os.Stdout, "Response from `AlertWatchersAPI.AlertWatchersGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiAlertWatchersGetRequest struct via the builder pattern

Name	Type	Description
authorization	string	Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
xRequestID	string	Supplied by client during request or generated by server.
continuationToken	string	A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string	Narrows down the results to only the response objects that satisfy the filter criteria.
limit	int32	Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	[]string	Performs the operation on the unique names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. If there is not at least one resource that matches each of the elements of `names`, then an error is returned, except when creating new resources.
offset	int32	The starting position based on the results of the query in relation to the full set of response objects returned.
sort	[]string	Sorts the response objects by the specified fields. Sorting can be applied to any field name in the response, in ascending order by default, or in descending order by prefixing the field name with a minus sign (-). Multiple fields can be specified as a comma-separated list (e.g., sort volumes by size descending, then by name ascending). If sort is provided, the response will not include a continuation_token.
totalItemCount	bool	If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

Return type

AlertWatcherGetResponse

Authorization

Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AlertWatchersPatch

AlertWatcherResponse AlertWatchersPatch(ctx).Names(names).AlertWatcher(alertWatcher).Authorization(authorization).XRequestID(xRequestID).Execute()

Modify alert watcher

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)

func main() {
    configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
        APIToken(apiToken).
        Build()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
    }
    apiClient, err := openapiclient.NewClient(configuration)
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
    }
    req := apiClient.AlertWatchersAPI.AlertWatchersPatch(context.Background())
    // Set request parameters ...

    resp, r, err := req.Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AlertWatchersAPI.AlertWatchersPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AlertWatchersPatch`: AlertWatcherResponse
    fmt.Fprintf(os.Stdout, "Response from `AlertWatchersAPI.AlertWatchersPatch`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiAlertWatchersPatchRequest struct via the builder pattern

Name	Type	Description
names	[]string	Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format.
alertWatcher	AlertWatcherPatch
authorization	string	Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
xRequestID	string	Supplied by client during request or generated by server.

Return type

AlertWatcherResponse

Authorization

Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AlertWatchersPost

AlertWatcherResponse AlertWatchersPost(ctx).Names(names).Authorization(authorization).XRequestID(xRequestID).AlertWatcher(alertWatcher).Execute()

Create alert watcher

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)

func main() {
    configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
        APIToken(apiToken).
        Build()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
    }
    apiClient, err := openapiclient.NewClient(configuration)
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
    }
    req := apiClient.AlertWatchersAPI.AlertWatchersPost(context.Background())
    // Set request parameters ...

    resp, r, err := req.Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AlertWatchersAPI.AlertWatchersPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AlertWatchersPost`: AlertWatcherResponse
    fmt.Fprintf(os.Stdout, "Response from `AlertWatchersAPI.AlertWatchersPost`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiAlertWatchersPostRequest struct via the builder pattern

Name	Type	Description
names	[]string	Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format.
authorization	string	Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
xRequestID	string	Supplied by client during request or generated by server.
alertWatcher	AlertWatcherPost

Return type

AlertWatcherResponse

Authorization

Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AlertWatchersTestGet

TestResultWithResourceGetResponse AlertWatchersTestGet(ctx).Authorization(authorization).XRequestID(xRequestID).AllowErrors(allowErrors).ContextNames(contextNames).ContinuationToken(continuationToken).Filter(filter).Limit(limit).Names(names).Offset(offset).Sort(sort).TotalItemCount(totalItemCount).Execute()

List alert watcher test

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)

func main() {
    configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
        APIToken(apiToken).
        Build()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
    }
    apiClient, err := openapiclient.NewClient(configuration)
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
    }
    req := apiClient.AlertWatchersAPI.AlertWatchersTestGet(context.Background())
    // Set request parameters ...

    resp, r, err := req.Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AlertWatchersAPI.AlertWatchersTestGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AlertWatchersTestGet`: TestResultWithResourceGetResponse
    fmt.Fprintf(os.Stdout, "Response from `AlertWatchersAPI.AlertWatchersTestGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiAlertWatchersTestGetRequest struct via the builder pattern

Name	Type	Description	Notes
authorization	string	Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
xRequestID	string	Supplied by client during request or generated by server.
allowErrors	bool	If set to `true`, the API will allow the operation to continue even if there are errors. Any errors will be returned in the `errors` field of the response. If set to `false`, the operation will fail if there are any errors.	[default to false]
contextNames	[]string	Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. Enter multiple names in comma-separated format. For example, `name01,name02`.
continuationToken	string	A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string	Narrows down the results to only the response objects that satisfy the filter criteria.
limit	int32	Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	[]string	Performs the operation on the unique names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. If there is not at least one resource that matches each of the elements of `names`, then an error is returned, except when creating new resources.
offset	int32	The starting position based on the results of the query in relation to the full set of response objects returned.
sort	[]string	Sorts the response objects by the specified fields. Sorting can be applied to any field name in the response, in ascending order by default, or in descending order by prefixing the field name with a minus sign (-). Multiple fields can be specified as a comma-separated list (e.g., sort volumes by size descending, then by name ascending). If sort is provided, the response will not include a continuation_token.
totalItemCount	bool	If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

Return type

TestResultWithResourceGetResponse

Authorization

Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Navigation Menu

Repository navigation

AlertWatchersAPI.md

AlertWatchersAPI.md

\AlertWatchersAPI

AlertWatchersDelete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AlertWatchersGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AlertWatchersPatch

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AlertWatchersPost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AlertWatchersTestGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

FilesExpand file tree

AlertWatchersAPI.md

Latest commit

History

AlertWatchersAPI.md

File metadata and controls

\AlertWatchersAPI

AlertWatchersDelete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AlertWatchersGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AlertWatchersPatch

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AlertWatchersPost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AlertWatchersTestGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers