archiving

package module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 21, 2025 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func NewConfiguration 

func NewConfiguration() *config.Configuration

NewConfiguration returns a new Configuration object

func ParameterValueToString 

func ParameterValueToString(obj interface{}, key string) string

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

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

APIClient manages communication with the STACKIT Archiving Service API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(opts ...config.ConfigurationOption) (*APIClient, error)

NewAPIClient creates a new API client. Optionally receives configuration options

func (*APIClient) CreateInstance 

func (a *APIClient) CreateInstance(ctx context.Context, projectId string) ApiCreateInstanceRequest

CreateInstance: provision a service instance

Provision a service instance. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId Project id on which user has permissions
@return ApiCreateInstanceRequest

func (*APIClient) CreateInstanceExecute 

func (a *APIClient) CreateInstanceExecute(ctx context.Context, projectId string) (*InstanceProvision, error)

func (*APIClient) DeleteInstance 

func (a *APIClient) DeleteInstance(ctx context.Context, projectId string, instanceId string) ApiDeleteInstanceRequest

DeleteInstance: delete service instance

Deprovision a service instance. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId Project id on which user has permissions
@param instanceId Instance id
@return ApiDeleteInstanceRequest

func (*APIClient) DeleteInstanceExecute 

func (a *APIClient) DeleteInstanceExecute(ctx context.Context, projectId string, instanceId string) error

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *config.Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

func (*APIClient) GetInstance 

func (a *APIClient) GetInstance(ctx context.Context, projectId string, instanceId string) ApiGetInstanceRequest

GetInstance: get a service instance

get a service instance 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId Project id on which user has permissions
@param instanceId Instance id
@return ApiGetInstanceRequest

func (*APIClient) GetInstanceExecute 

func (a *APIClient) GetInstanceExecute(ctx context.Context, projectId string, instanceId string) (*Instance, error)

func (*APIClient) ListInstances 

func (a *APIClient) ListInstances(ctx context.Context, projectId string) ApiListInstancesRequest

ListInstances: get service instances list

Get a list of available instances 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId Project id on which user has permissions
@return ApiListInstancesRequest

func (*APIClient) ListInstancesExecute 

func (a *APIClient) ListInstancesExecute(ctx context.Context, projectId string) (*ListInstancesResponse, error)

func (*APIClient) PartialUpdateInstance 

func (a *APIClient) PartialUpdateInstance(ctx context.Context, projectId string, instanceId string) ApiPartialUpdateInstanceRequest

PartialUpdateInstance: update a service instance

Update a service instance. This could be a repository update. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectId Project id on which user has permissions
@param instanceId Instance id
@return ApiPartialUpdateInstanceRequest

func (*APIClient) PartialUpdateInstanceExecute 

func (a *APIClient) PartialUpdateInstanceExecute(ctx context.Context, projectId string, instanceId string) error

type ApiCreateInstanceRequest 

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

func (ApiCreateInstanceRequest) CreateInstancePayload 

func (r ApiCreateInstanceRequest) CreateInstancePayload(createInstancePayload CreateInstancePayload) ApiCreateInstanceRequest

func (ApiCreateInstanceRequest) Execute 

func (r ApiCreateInstanceRequest) Execute() (*InstanceProvision, error)

type ApiDeleteInstanceRequest 

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

func (ApiDeleteInstanceRequest) Execute 

func (r ApiDeleteInstanceRequest) Execute() error

type ApiGetInstanceRequest 

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

func (ApiGetInstanceRequest) Execute 

func (r ApiGetInstanceRequest) Execute() (*Instance, error)

type ApiListInstancesRequest 

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

func (ApiListInstancesRequest) Execute 

func (r ApiListInstancesRequest) Execute() (*ListInstancesResponse, error)

type ApiPartialUpdateInstanceRequest 

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

func (ApiPartialUpdateInstanceRequest) Execute 

func (r ApiPartialUpdateInstanceRequest) Execute() error

func (ApiPartialUpdateInstanceRequest) PartialUpdateInstancePayload 

func (r ApiPartialUpdateInstanceRequest) PartialUpdateInstancePayload(partialUpdateInstancePayload PartialUpdateInstancePayload) ApiPartialUpdateInstanceRequest

type CreateInstancePayload 

type CreateInstancePayload struct {
	// REQUIRED
	Parameters *InstanceParameters `json:"parameters"`
}

type DefaultApiService 

type DefaultApiService service

DefaultApiService DefaultApi service

type Error 

type Error struct {
	// REQUIRED
	Description *string `json:"description"`
	// REQUIRED
	Error *string `json:"error"`
}

type Instance 

type Instance struct {
	// REQUIRED
	InstanceId *string `json:"instanceId"`
	// REQUIRED
	Parameters *InstanceParameters `json:"parameters"`
	Status     *string             `json:"status,omitempty"`
}

type InstanceParameters 

type InstanceParameters struct {
	// Billing address for Service
	// REQUIRED
	BillingAddress *string `json:"billingAddress"`
	// Date of instance creation
	CreatedAt     *string                          `json:"createdAt,omitempty"`
	FiscalYearEnd *InstanceParametersFiscalYearEnd `json:"fiscalYearEnd,omitempty"`
	// REQUIRED
	Kind *string `json:"kind"`
	// Service name
	// REQUIRED
	ServiceName *string `json:"serviceName"`
	// REQUIRED
	System *InstanceParametersSystem `json:"system"`
	// Version of operator kind
	Version *string `json:"version,omitempty"`
}

type InstanceParametersFiscalYearEnd 

type InstanceParametersFiscalYearEnd struct {
	// Day that marks the end of fiscal year.
	// Can be cast to int32 without loss of precision.
	Day *int64 `json:"day,omitempty"`
	// Month that marks the end of fiscal year.
	// Can be cast to int32 without loss of precision.
	Month *int64 `json:"month,omitempty"`
}

type InstanceParametersSystem 

type InstanceParametersSystem struct {
	// The Auth. ID is used to check signed requests and must be the same as the file name of the generated certificate. The Auth. ID should be specified without spaces. Only for SAP Archive Link
	AuthId *string `json:"authId,omitempty"`
	// Repositories of connected system.
	// REQUIRED
	Repositories *[]InstanceParametersSystemRepositoriesInner `json:"repositories"`
	// The name of the SAP system is used in the URL that is stored in SAP in the content repository. Only for SAP Archive Link
	SapName *string `json:"sapName,omitempty"`
}

type InstanceParametersSystemRepositoriesInner 

type InstanceParametersSystemRepositoriesInner struct {
	// The name of the connected repository.
	// REQUIRED
	Name                   *string                                                          `json:"name"`
	StorageRetentionOffset *InstanceParametersSystemRepositoriesInnerStorageRetentionOffset `json:"storageRetentionOffset,omitempty"`
}

type InstanceParametersSystemRepositoriesInnerStorageRetentionOffset 

type InstanceParametersSystemRepositoriesInnerStorageRetentionOffset struct {
	// Day component of the retention date. A '+' or '-' prefix indicates an offset from the current date.
	RetentionDays *string `json:"retentionDays,omitempty"`
	// Month component of the retention date. A '+' or '-' prefix indicates an offset from the current date.
	RetentionMonths *string `json:"retentionMonths,omitempty"`
	// Year component of the retention date. A '+' or '-' prefix indicates an offset from the current date.
	RetentionYears *string `json:"retentionYears,omitempty"`
}

type InstanceProvision 

type InstanceProvision struct {
	// Archiving endpoint for archiving instance
	// REQUIRED
	ArchivingURI *string `json:"archivingURI"`
	// Technical user password for archiving instance
	// REQUIRED
	ArchivingUserPassword *string `json:"archivingUserPassword"`
	// Technical user name for archiving instance
	// REQUIRED
	ArchivingUsername *string `json:"archivingUsername"`
	// REQUIRED
	InstanceId *string `json:"instanceId"`
	// Password for SAP Archive Link administration UI
	SapAdminPassword *string `json:"sapAdminPassword,omitempty"`
	// URL for accessing SAP Archive Link administration UI
	SapAdminURL *string `json:"sapAdminURL,omitempty"`
	// Username for SAP Archive Link administration UI
	SapAdminUsername *string `json:"sapAdminUsername,omitempty"`
}

type InstanceUpdateParameters 

type InstanceUpdateParameters struct {
	// Billing address for Service
	// REQUIRED
	BillingAddress *string                          `json:"billingAddress"`
	FiscalYearEnd  *InstanceParametersFiscalYearEnd `json:"fiscalYearEnd,omitempty"`
	// Service name
	// REQUIRED
	ServiceName *string `json:"serviceName"`
	// REQUIRED
	System *InstanceParametersSystem `json:"system"`
}

type ListInstancesResponse 

type ListInstancesResponse struct {
	// REQUIRED
	Instances *[]Instance `json:"instances"`
}

type MappedNullable 

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type NullableBool 

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

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableFloat32 

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

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

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

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableInt 

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

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

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

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

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

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableString 

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

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

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

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type PartialUpdateInstancePayload 

type PartialUpdateInstancePayload struct {
	InstanceId   *string                   `json:"instanceId,omitempty"`
	InstanceName *string                   `json:"instanceName,omitempty"`
	Parameters   *InstanceUpdateParameters `json:"parameters,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.