atrackerv2

type AtrackerV2 struct {
	Service *core.BaseService
}

type AtrackerV2Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

type CosEndpoint struct {
	// The host name of the Cloud Object Storage endpoint.
	Endpoint *string `json:"endpoint" validate:"required"`

	// The CRN of the Cloud Object Storage instance.
	TargetCRN *string `json:"target_crn" validate:"required"`

	// The bucket name under the Cloud Object Storage instance.
	Bucket *string `json:"bucket" validate:"required"`

	// ATracker service is enabled to support service to service authentication. If service to service is enabled then set
	// this flag is true and do not supply apikey.
	ServiceToServiceEnabled *bool `json:"service_to_service_enabled" validate:"required"`
}

type CosEndpointPrototype struct {
	// The host name of the Cloud Object Storage endpoint.
	Endpoint *string `json:"endpoint" validate:"required"`

	// The CRN of the Cloud Object Storage instance.
	TargetCRN *string `json:"target_crn" validate:"required"`

	// The bucket name under the Cloud Object Storage instance.
	Bucket *string `json:"bucket" validate:"required"`

	// The IAM API key that has writer access to the Cloud Object Storage instance. This credential is masked in the
	// response. This is required if service_to_service is not enabled.
	APIKey *string `json:"api_key,omitempty"`

	// ATracker service is enabled to support service to service authentication. If service to service is enabled then set
	// this flag is true and do not supply apikey.
	ServiceToServiceEnabled *bool `json:"service_to_service_enabled,omitempty"`
}

type CreateRouteOptions struct {
	// The name of the route. The name must be 1000 characters or less and cannot include any special characters other than
	// `(space) - . _ :`. Do not include any personal identifying information (PII) in any resource names.
	Name *string `json:"name" validate:"required"`

	// Routing rules that will be evaluated in their order of the array.
	Rules []RulePrototype `json:"rules" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type CreateTargetOptions struct {
	// The name of the target. The name must be 1000 characters or less, and cannot include any special characters other
	// than `(space) - . _ :`. Do not include any personal identifying information (PII) in any resource names.
	Name *string `json:"name" validate:"required"`

	// The type of the target. It can be cloud_object_storage, logdna or event_streams. Based on this type you must include
	// cos_endpoint, logdna_endpoint or eventstreams_endpoint.
	TargetType *string `json:"target_type" validate:"required"`

	// Property values for a Cloud Object Storage Endpoint in requests.
	CosEndpoint *CosEndpointPrototype `json:"cos_endpoint,omitempty"`

	// Property values for a LogDNA Endpoint in requests.
	LogdnaEndpoint *LogdnaEndpointPrototype `json:"logdna_endpoint,omitempty"`

	// Property values for an Event Streams Endpoint in requests.
	EventstreamsEndpoint *EventstreamsEndpointPrototype `json:"eventstreams_endpoint,omitempty"`

	// Include this optional field if you want to create a target in a different region other than the one you are
	// connected.
	Region *string `json:"region,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteRouteOptions struct {
	// The v4 UUID that uniquely identifies the route.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteTargetOptions struct {
	// The v4 UUID that uniquely identifies the target.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type EventstreamsEndpoint struct {
	// The CRN of the Event Streams instance.
	TargetCRN *string `json:"target_crn" validate:"required"`

	// List of broker endpoints.
	Brokers []string `json:"brokers" validate:"required"`

	// The messsage hub topic defined in the Event Streams instance.
	Topic *string `json:"topic" validate:"required"`

	// The user password (api key) for the message hub topic in the Event Streams instance.
	APIKey *string `json:"api_key" validate:"required"`
}

type EventstreamsEndpointPrototype struct {
	// The CRN of the Event Streams instance.
	TargetCRN *string `json:"target_crn" validate:"required"`

	// List of broker endpoints.
	Brokers []string `json:"brokers" validate:"required"`

	// The messsage hub topic defined in the Event Streams instance.
	Topic *string `json:"topic" validate:"required"`

	// The user password (api key) for the message hub topic in the Event Streams instance.
	APIKey *string `json:"api_key" validate:"required"`
}

type GetMigrationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetRouteOptions struct {
	// The v4 UUID that uniquely identifies the route.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetSettingsOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetTargetOptions struct {
	// The v4 UUID that uniquely identifies the target.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListRoutesOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListTargetsOptions struct {
	// Limit the query to the specified region.
	Region *string `json:"region,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type LogdnaEndpoint struct {
	// The CRN of the LogDNA instance.
	TargetCRN *string `json:"target_crn" validate:"required"`
}

type LogdnaEndpointPrototype struct {
	// The CRN of the LogDNA instance.
	TargetCRN *string `json:"target_crn" validate:"required"`

	// The LogDNA ingestion key is used for routing logs to a specific LogDNA instance.
	IngestionKey *string `json:"ingestion_key" validate:"required"`
}

type Migration struct {
	// The overall migration progress as a percentage.
	Progress *int64 `json:"progress" validate:"required"`

	// The overall status of the migration.
	Status *string `json:"status" validate:"required"`

	// List containing the migration status for each of the routes and targets that are or will be migrated.
	MigrationItems []MigrationItem `json:"migration_items" validate:"required"`
}

type MigrationItem struct {
	// The type of the resource being migrated.
	ResourceType *string `json:"resource_type" validate:"required"`

	// The uuid of the route or target.
	ID *string `json:"id" validate:"required"`

	// The region where the resource is defined.
	Region *string `json:"region" validate:"required"`

	// The status of the migration for this resource.
	Status *string `json:"status" validate:"required"`

	// The detailed status message of the migration for this resource.  In the event of a failure this will contain the
	// details as to why the migration failed for this resource.
	DetailedStatus []string `json:"detailed_status" validate:"required"`

	// Migration error encountered.
	Error *string `json:"error,omitempty"`
}

type PostMigrationOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type PutSettingsOptions struct {
	// To store all your meta data in a single region.
	MetadataRegionPrimary *string `json:"metadata_region_primary" validate:"required"`

	// If you set this true then you cannot access api through public network.
	PrivateAPIEndpointOnly *bool `json:"private_api_endpoint_only" validate:"required"`

	// The target ID List. In the event that no routing rule causes the event to be sent to a target, these targets will
	// receive the event.
	DefaultTargets []string `json:"default_targets,omitempty"`

	// If present then only these regions may be used to define a target.
	PermittedTargetRegions []string `json:"permitted_target_regions,omitempty"`

	// To store all your meta data in a backup region.
	MetadataRegionBackup *string `json:"metadata_region_backup,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ReplaceRouteOptions struct {
	// The v4 UUID that uniquely identifies the route.
	ID *string `json:"id" validate:"required,ne="`

	// The name of the route. The name must be 1000 characters or less and cannot include any special characters other than
	// `(space) - . _ :`. Do not include any personal identifying information (PII) in any resource names.
	Name *string `json:"name" validate:"required"`

	// Routing rules that will be evaluated in their order of the array.
	Rules []RulePrototype `json:"rules" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ReplaceTargetOptions struct {
	// The v4 UUID that uniquely identifies the target.
	ID *string `json:"id" validate:"required,ne="`

	// The name of the target. The name must be 1000 characters or less, and cannot include any special characters other
	// than `(space) - . _ :`. Do not include any personal identifying information (PII) in any resource names.
	Name *string `json:"name,omitempty"`

	// Property values for a Cloud Object Storage Endpoint in requests.
	CosEndpoint *CosEndpointPrototype `json:"cos_endpoint,omitempty"`

	// Property values for a LogDNA Endpoint in requests.
	LogdnaEndpoint *LogdnaEndpointPrototype `json:"logdna_endpoint,omitempty"`

	// Property values for an Event Streams Endpoint in requests.
	EventstreamsEndpoint *EventstreamsEndpointPrototype `json:"eventstreams_endpoint,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type Route struct {
	// The uuid of the route resource.
	ID *string `json:"id" validate:"required"`

	// The name of the route.
	Name *string `json:"name" validate:"required"`

	// The crn of the route resource.
	CRN *string `json:"crn" validate:"required"`

	// The version of the route.
	Version *int64 `json:"version,omitempty"`

	// The routing rules that will be evaluated in their order of the array. Once a rule is matched, the remaining rules in
	// the route definition will be skipped.
	Rules []Rule `json:"rules" validate:"required"`

	// The timestamp of the route creation time.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The timestamp of the route last updated time.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// The API version of the route.
	APIVersion *int64 `json:"api_version" validate:"required"`

	// An optional message containing information about the route.
	Message *string `json:"message,omitempty"`
}

type RouteList struct {
	// A list of route resources.
	Routes []Route `json:"routes" validate:"required"`
}

type Rule struct {
	// The target ID List. All the events will be send to all targets listed in the rule. You can include targets from
	// other regions.
	TargetIds []string `json:"target_ids" validate:"required"`

	// Logs from these locations will be sent to the targets specified. Locations is a superset of regions including global
	// and *.
	Locations []string `json:"locations" validate:"required"`
}

type RulePrototype struct {
	// The target ID List. All the events will be send to all targets listed in the rule. You can include targets from
	// other regions.
	TargetIds []string `json:"target_ids" validate:"required"`

	// Logs from these locations will be sent to the targets specified. Locations is a superset of regions including global
	// and *.
	Locations []string `json:"locations,omitempty"`
}

type Settings struct {
	// The target ID List. In the event that no routing rule causes the event to be sent to a target, these targets will
	// receive the event.
	DefaultTargets []string `json:"default_targets" validate:"required"`

	// If present then only these regions may be used to define a target.
	PermittedTargetRegions []string `json:"permitted_target_regions" validate:"required"`

	// To store all your meta data in a single region.
	MetadataRegionPrimary *string `json:"metadata_region_primary" validate:"required"`

	// To store all your meta data in a backup region.
	MetadataRegionBackup *string `json:"metadata_region_backup,omitempty"`

	// If you set this true then you cannot access api through public network.
	PrivateAPIEndpointOnly *bool `json:"private_api_endpoint_only" validate:"required"`

	// The lowest API version of targets or routes that customer might have under his or her account.
	APIVersion *int64 `json:"api_version" validate:"required"`

	// An optional message containing information about the audit log locations.
	Message *string `json:"message,omitempty"`
}

type Target struct {
	// The uuid of the target resource.
	ID *string `json:"id" validate:"required"`

	// The name of the target resource.
	Name *string `json:"name" validate:"required"`

	// The crn of the target resource.
	CRN *string `json:"crn" validate:"required"`

	// The type of the target.
	TargetType *string `json:"target_type" validate:"required"`

	// Included this optional field if you used it to create a target in a different region other than the one you are
	// connected.
	Region *string `json:"region,omitempty"`

	// Property values for a Cloud Object Storage Endpoint in responses.
	CosEndpoint *CosEndpoint `json:"cos_endpoint,omitempty"`

	// Property values for a LogDNA Endpoint in responses.
	LogdnaEndpoint *LogdnaEndpoint `json:"logdna_endpoint,omitempty"`

	// Property values for the Event Streams Endpoint in responses.
	EventstreamsEndpoint *EventstreamsEndpoint `json:"eventstreams_endpoint,omitempty"`

	// The status of the write attempt to the target with the provided endpoint parameters.
	WriteStatus *WriteStatus `json:"write_status" validate:"required"`

	// The timestamp of the target creation time.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// The timestamp of the target last updated time.
	UpdatedAt *strfmt.DateTime `json:"updated_at" validate:"required"`

	// An optional message containing information about the target.
	Message *string `json:"message,omitempty"`

	// The API version of the target.
	APIVersion *int64 `json:"api_version" validate:"required"`
}

type TargetList struct {
	// A list of target resources.
	Targets []Target `json:"targets" validate:"required"`
}

type ValidateTargetOptions struct {
	// The v4 UUID that uniquely identifies the target.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type Warning struct {
	// The warning code.
	Code *string `json:"code" validate:"required"`

	// The warning message.
	Message *string `json:"message" validate:"required"`
}

type WarningReport struct {
	// The status code.
	StatusCode *int64 `json:"status_code,omitempty"`

	// The transaction-id of the API request.
	Trace *string `json:"trace,omitempty"`

	// The warning array triggered by the API request.
	Warnings []Warning `json:"warnings,omitempty"`
}

type WriteStatus struct {
	// The status such as failed or success.
	Status *string `json:"status" validate:"required"`

	// The timestamp of the failure.
	LastFailure *strfmt.DateTime `json:"last_failure,omitempty"`

	// Detailed description of the cause of the failure.
	ReasonForLastFailure *string `json:"reason_for_last_failure,omitempty"`
}