Documentation ¶
Overview ¶
Package src
====> This is a sample usage of NATS Connect. The CLI part is to allow an easy place to start. ====> The run function is the code to drop into you program.
Copyright 6/5/24 STY Holdings Inc
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Package src /* ====> This is a sample usage of NATS Connect. The CLI part is to allow an easy place to start. ====> The run function is the code to drop into you program.
Copyright 6/5/24 STY Holdings Inc
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
Package src ¶
====> This is a sample usage of NATS Connect. The CLI part is to allow an easy place to start. ====> The run function is the code to drop into you program.
Copyright 6/5/24 STY Holdings Inc
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Package src /* Copyright 1/2024 STY Holdings Inc
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
Index ¶
- Constants
- type NCClient
- func (clientPtr *NCClient) SynaidaGetPersonalAccessToken(request interface{}) (reply ncs.GetPersonalAccessTokenReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaGetSystem(request interface{}) (reply ncs.GetSystemReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaGetSystemLimits(request interface{}) (reply ncs.GetSystemLimitsReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaGetTeam(request interface{}) (reply ncs.GetTeamReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaGetTeamLimits(request interface{}) (reply ncs.GetTeamLimitsReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaGetVersion(request interface{}) (reply ncs.GetVersionReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaListAccounts(request interface{}) (reply ncs.ListAccountsReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaListInfoAppUsersTeam(request interface{}) (reply ncs.ListInfoAppUsersTeamReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaListNATSUsers(request interface{}) (reply ncs.ListNATSUsersReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaListPersonalAccessTokens(request interface{}) (reply ncs.ListPersonalAccessTokensReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaListSystemAccountInfo(request interface{}) (reply ncs.ListSystemAccountInfoReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaListSystemServerInfo(request interface{}) (reply ncs.ListSystemServerInfoReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaListSystems(request interface{}) (reply ncs.ListSystemsReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaListTeamServerAccounts(request interface{}) (reply ncs.ListTeamServerAccountsReply, errorInfo pi.ErrorInfo)
- func (clientPtr *NCClient) SynaidaListTeams(request interface{}) (reply ncs.ListTeamsReply, errorInfo pi.ErrorInfo)
- type SaaSKeysTokens
Constants ¶
const ( PROGRAM_NAME = "NATS-Connect-go-client" NC_SSM_PARAMETER_PREFIX = "nc" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type NCClient ¶
type NCClient struct {
// contains filtered or unexported fields
}
func NewNCClient ¶
func NewNCClient(styhClientId, environment, password, secretKey, tempDirectory, username, configFileFQN string) ( NCClientPtr NCClient, errorInfo pi.ErrorInfo, )
NewNCClient - creates an instance to connect to the NATS Connect server
Customer Messages: None Errors: ErrRequiredArgumentMissing, returned from validateConfiguration, LoadAWSCustomerSettings, Login, processAWSClientParameters, BuildTemporaryFiles, BuildTLSTemporaryFiles, BuildInstanceName, GetConnection Verifications: styhClientId, environment, password, secretKey, tempDirectory, username, configFileFQN
func (*NCClient) SynaidaGetPersonalAccessToken ¶
func (clientPtr *NCClient) SynaidaGetPersonalAccessToken(request interface{}) (reply ncs.GetPersonalAccessTokenReply, errorInfo pi.ErrorInfo)
SynaidaGetPersonalAccessToken - will provide information about your token
func (*NCClient) SynaidaGetSystem ¶
func (clientPtr *NCClient) SynaidaGetSystem(request interface{}) (reply ncs.GetSystemReply, errorInfo pi.ErrorInfo)
SynaidaGetSystem - will provide information about the system
func (*NCClient) SynaidaGetSystemLimits ¶
func (clientPtr *NCClient) SynaidaGetSystemLimits(request interface{}) (reply ncs.GetSystemLimitsReply, errorInfo pi.ErrorInfo)
SynaidaGetSystemLimits - will provide information about the system limits
func (*NCClient) SynaidaGetTeam ¶
func (clientPtr *NCClient) SynaidaGetTeam(request interface{}) (reply ncs.GetTeamReply, errorInfo pi.ErrorInfo)
SynaidaGetTeam - will provide information about the team
func (*NCClient) SynaidaGetTeamLimits ¶
func (clientPtr *NCClient) SynaidaGetTeamLimits(request interface{}) (reply ncs.GetTeamLimitsReply, errorInfo pi.ErrorInfo)
SynaidaGetTeamLimits - will provide information about the team's limits
func (*NCClient) SynaidaGetVersion ¶
func (clientPtr *NCClient) SynaidaGetVersion(request interface{}) (reply ncs.GetVersionReply, errorInfo pi.ErrorInfo)
SynaidaGetVersion - will provide the version information
func (*NCClient) SynaidaListAccounts ¶
func (clientPtr *NCClient) SynaidaListAccounts(request interface{}) (reply ncs.ListAccountsReply, errorInfo pi.ErrorInfo)
SynaidaListAccounts - will list the account for a system id
func (*NCClient) SynaidaListInfoAppUsersTeam ¶
func (clientPtr *NCClient) SynaidaListInfoAppUsersTeam(request interface{}) (reply ncs.ListInfoAppUsersTeamReply, errorInfo pi.ErrorInfo)
SynaidaListInfoAppUsersTeam - will list the user account for a team id
func (*NCClient) SynaidaListNATSUsers ¶
func (clientPtr *NCClient) SynaidaListNATSUsers(request interface{}) (reply ncs.ListNATSUsersReply, errorInfo pi.ErrorInfo)
func (*NCClient) SynaidaListPersonalAccessTokens ¶
func (clientPtr *NCClient) SynaidaListPersonalAccessTokens(request interface{}) (reply ncs.ListPersonalAccessTokensReply, errorInfo pi.ErrorInfo)
SynaidaListPersonalAccessTokens - will list your personal access tokens
func (*NCClient) SynaidaListSystemAccountInfo ¶
func (clientPtr *NCClient) SynaidaListSystemAccountInfo(request interface{}) (reply ncs.ListSystemAccountInfoReply, errorInfo pi.ErrorInfo)
SynaidaListSystemAccountInfo - will list system account info
func (*NCClient) SynaidaListSystemServerInfo ¶
func (clientPtr *NCClient) SynaidaListSystemServerInfo(request interface{}) (reply ncs.ListSystemServerInfoReply, errorInfo pi.ErrorInfo)
func (*NCClient) SynaidaListSystems ¶
func (clientPtr *NCClient) SynaidaListSystems(request interface{}) (reply ncs.ListSystemsReply, errorInfo pi.ErrorInfo)
SynaidaListSystems - will list systems for a team
func (*NCClient) SynaidaListTeamServerAccounts ¶
func (clientPtr *NCClient) SynaidaListTeamServerAccounts(request interface{}) (reply ncs.ListTeamServerAccountsReply, errorInfo pi.ErrorInfo)
SynaidaListTeamServerAccounts - will list all service accounts for the team This appears to be a restricted API. Only tested using a personal account.
func (*NCClient) SynaidaListTeams ¶
func (clientPtr *NCClient) SynaidaListTeams(request interface{}) (reply ncs.ListTeamsReply, errorInfo pi.ErrorInfo)
SynaidaListTeams - returns information about all your teams