transmitter

Documentation

Overview

* NTT Security Holdings Go Library for Samurai * Copyright 2023 NTT Security Holdings * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* NTT Security Holdings Go Library for Samurai * Copyright 2023 NTT Security Holdings * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* NTT Security Holdings Go Library for Samurai * Copyright 2023 NTT Security Holdings * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

Index

• Variables
• type Client
  • func NewClient(settings Settings, credentials credentials.APICredentials) (Client, error)
  • func (client Client) SendFile(fd FileDetails) error
• type FileDetails
• type Settings

Variables

var ErrFileExists = errors.New("file already exists")

var ErrUnknownPayload = errors.New("unknown payload")

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(settings Settings, credentials credentials.APICredentials) (Client, error)

func (Client) SendFile

func (client Client) SendFile(fd FileDetails) error

type FileDetails

type FileDetails struct {
	SourceFilename      string
	DestinationFilename string
	FileSuffix          string
	PayloadType         string
}

type Settings

type Settings struct {
	AllowInsecureTLS bool   `yaml:"insecure"`
	Debug            bool   `yaml:"debug"`
	Profile          string `yaml:"profile"`
	MaxRetries       int    `yaml:"max_retries"`
}