package
4.8.0+incompatible
Repository: https://github.com/puppetlabs/relay.git
Documentation: pkg.go.dev

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
NewDeletedResource instantiates a new DeletedResource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDeletedResourceWithDefaults instantiates a new DeletedResource object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEntity instantiates a new Entity object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEntityAccess instantiates a new EntityAccess object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEntityAccessWithDefaults instantiates a new EntityAccess object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEntityWithDefaults instantiates a new Entity object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorDescription instantiates a new ErrorDescription object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorDescriptionWithDefaults instantiates a new ErrorDescription object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewErrorFormatted instantiates a new ErrorFormatted object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorFormattedWithDefaults instantiates a new ErrorFormatted object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInlineResponse200 instantiates a new InlineResponse200 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInlineResponse2002 instantiates a new InlineResponse2002 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInlineResponse2002WithDefaults instantiates a new InlineResponse2002 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInlineResponse2005 instantiates a new InlineResponse2005 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInlineResponse2005WithDefaults instantiates a new InlineResponse2005 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInlineResponse200WithDefaults instantiates a new InlineResponse200 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInlineResponseDefault instantiates a new InlineResponseDefault object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInlineResponseDefaultWithDefaults instantiates a new InlineResponseDefault object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLifecycle instantiates a new Lifecycle object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLifecycleWithDefaults instantiates a new Lifecycle object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotification instantiates a new Notification object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotificationAllOf instantiates a new NotificationAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotificationAllOfWithDefaults instantiates a new NotificationAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotificationEntity instantiates a new NotificationEntity object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotificationEntityWithDefaults instantiates a new NotificationEntity object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotificationIdentifier instantiates a new NotificationIdentifier object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotificationIdentifiers instantiates a new NotificationIdentifiers object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotificationIdentifiersWithDefaults instantiates a new NotificationIdentifiers object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotificationIdentifierWithDefaults instantiates a new NotificationIdentifier object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotificationList instantiates a new NotificationList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotificationListWithDefaults instantiates a new NotificationList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotifications instantiates a new Notifications object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotificationsResponse instantiates a new NotificationsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotificationsResponseWithDefaults instantiates a new NotificationsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotificationSummary instantiates a new NotificationSummary object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotificationSummaryAllOf instantiates a new NotificationSummaryAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotificationSummaryAllOfWithDefaults instantiates a new NotificationSummaryAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotificationSummaryWithDefaults instantiates a new NotificationSummary object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotificationsWithDefaults instantiates a new Notifications object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotificationWithDefaults instantiates a new Notification object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPermission instantiates a new Permission object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPermissionGrant instantiates a new PermissionGrant object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPermissionGrantWithDefaults instantiates a new PermissionGrant object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPermissionIdentifier instantiates a new PermissionIdentifier object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPermissionIdentifierWithDefaults instantiates a new PermissionIdentifier object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPermissionSummary instantiates a new PermissionSummary object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPermissionSummaryAllOf instantiates a new PermissionSummaryAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPermissionSummaryAllOfWithDefaults instantiates a new PermissionSummaryAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPermissionSummaryWithDefaults instantiates a new PermissionSummary object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPermissionWithDefaults instantiates a new Permission object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTokenRequest instantiates a new TokenRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTokenRequestWithDefaults instantiates a new TokenRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTokenResponse instantiates a new TokenResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTokenResponseAllOf instantiates a new TokenResponseAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTokenResponseAllOfWithDefaults instantiates a new TokenResponseAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTokenResponseWithDefaults instantiates a new TokenResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTokens instantiates a new Tokens object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTokensWithDefaults instantiates a new Tokens object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserDigestSettings instantiates a new UserDigestSettings object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserDigestSettingsWithDefaults instantiates a new UserDigestSettings object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserProfile instantiates a new UserProfile object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserProfileAllOf instantiates a new UserProfileAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserProfileAllOfWithDefaults instantiates a new UserProfileAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserProfileSettings instantiates a new UserProfileSettings object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserProfileSettingsWithDefaults instantiates a new UserProfileSettings object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserProfileWithDefaults instantiates a new UserProfile object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserSubscriptionChannels instantiates a new UserSubscriptionChannels object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserSubscriptionChannelsWithDefaults instantiates a new UserSubscriptionChannels object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserSubscriptionSettings instantiates a new UserSubscriptionSettings object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserSubscriptionSettingsWithDefaults instantiates a new UserSubscriptionSettings object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserSummary instantiates a new UserSummary object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserSummaryAllOf instantiates a new UserSummaryAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserSummaryAllOfWithDefaults instantiates a new UserSummaryAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserSummaryWithDefaults instantiates a new UserSummary object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserToken instantiates a new UserToken object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserTokenWithDefaults instantiates a new UserToken object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserTokenWithSecret instantiates a new UserTokenWithSecret object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserTokenWithSecretAllOf instantiates a new UserTokenWithSecretAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserTokenWithSecretAllOfWithDefaults instantiates a new UserTokenWithSecretAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserTokenWithSecretWithDefaults instantiates a new UserTokenWithSecret object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserWorkflowsSubscriptions instantiates a new UserWorkflowsSubscriptions object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserWorkflowsSubscriptionsWithDefaults instantiates a new UserWorkflowsSubscriptions object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserWorkflowSubscriptions instantiates a new UserWorkflowSubscriptions object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserWorkflowSubscriptionSettings instantiates a new UserWorkflowSubscriptionSettings object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserWorkflowSubscriptionSettingsWithDefaults instantiates a new UserWorkflowSubscriptionSettings object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserWorkflowSubscriptionsSummary instantiates a new UserWorkflowSubscriptionsSummary object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserWorkflowSubscriptionsSummaryAllOf instantiates a new UserWorkflowSubscriptionsSummaryAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserWorkflowSubscriptionsSummaryAllOfWithDefaults instantiates a new UserWorkflowSubscriptionsSummaryAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserWorkflowSubscriptionsSummaryWithDefaults instantiates a new UserWorkflowSubscriptionsSummary object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserWorkflowSubscriptionsWithDefaults instantiates a new UserWorkflowSubscriptions object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.
UserTokenAsToken is a convenience function that returns UserToken wrapped in Token.
UserTokenWithSecretAsTokenWithSecret is a convenience function that returns UserTokenWithSecret wrapped in TokenWithSecret.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

APIClient manages communication with the Relay API API vv20200615 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
DeletedResource Information about the deleted resource.
Entity A general response for a single entity.
EntityAccess Access control information for a given entity.
Error An error.
ErrorDescription struct for ErrorDescription.
ErrorFormatted struct for ErrorFormatted.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
InlineResponse200 The response type for access to global entities.
InlineResponse2002 Success response.
InlineResponse2005 The response type for the global permissions list.
InlineResponseDefault Error response.
Lifecycle An object with created and updated times.
Notification struct for Notification.
NotificationAllOf An external event.
NotificationEntity struct for NotificationEntity.
NotificationIdentifier A unique identifier for a notification.
NotificationIdentifiers A list of notifications.
NotificationList The response type for listing notifications.
Notifications The response type for listing notifications.
NotificationsResponse struct for NotificationsResponse.
NotificationSummary struct for NotificationSummary.
NotificationSummaryAllOf A summary of a notification.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Permission struct for Permission.
PermissionGrant A permission resolved in a given context, such as a user in an entity.
PermissionIdentifier A unique identifier for a system permission.
PermissionSummary struct for PermissionSummary.
PermissionSummaryAllOf A summary of a system permission.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Token - An access token.
TokenRequest The token to create.
TokenResponse struct for TokenResponse.
TokenResponseAllOf The response for a newly created token.
Tokens A list of tokens.
TokenWithSecret - A newly created token with secret.
UserDigestSettings User digest settings.
UserProfile struct for UserProfile.
UserProfileAllOf A user's profile.
UserProfileSettings User profile settings.
UserSubscriptionChannels User subscription channels.
UserSubscriptionSettings User subscription settings.
UserSummary struct for UserSummary.
UserSummaryAllOf The information about an account user.
UserToken User token for authentication.
UserTokenWithSecret struct for UserTokenWithSecret.
UserTokenWithSecretAllOf A user token with the secret.
UserWorkflowsSubscriptions An object containing an array of workflow subscriptions.
UserWorkflowSubscriptions User subscription options for a workflow.
UserWorkflowSubscriptionSettings User workflow subscription settings.
UserWorkflowSubscriptionsSummary struct for UserWorkflowSubscriptionsSummary.
UserWorkflowSubscriptionsSummaryAllOf User notification options for a workflow.

# Type aliases

AccessControlApiService AccessControlApi service.
AuthApiService AuthApi service.
BillingApiService BillingApi service.
ConnectionProvidersApiService ConnectionProvidersApi service.
ConnectionsApiService ConnectionsApi service.
EventsApiService EventsApi service.
NotificationsApiService NotificationsApi service.
RevisionsApiService RevisionsApi service.
ServerConfigurations stores multiple ServerConfiguration items.
SubscriptionsApiService SubscriptionsApi service.
TermsApiService TermsApi service.
TokensApiService TokensApi service.
WorkflowRevisionsApiService WorkflowRevisionsApi service.
WorkflowRunsApiService WorkflowRunsApi service.
WorkflowsApiService WorkflowsApi service.
WorkflowSecretsApiService WorkflowSecretsApi service.
WorkflowTriggersApiService WorkflowTriggersApi service.