globaltaggingv1

type AttachTagOptions struct {
	// List of resources on which the tag or tags are attached.
	Resources []Resource `json:"resources" validate:"required"`

	// The name of the tag to attach.
	TagName *string `json:"tag_name,omitempty"`

	// An array of tag names to attach.
	TagNames []string `json:"tag_names,omitempty"`

	// An alphanumeric string that is used to trace the request. The value  may include ASCII alphanumerics and any of
	// following segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024
	// bytes. The value is considered invalid and must be ignored if that value includes any other character or is longer
	// than 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XRequestID *string `json:"x-request-id,omitempty"`

	// An alphanumeric string that is used to trace the request as a part of a larger context: the same value is used for
	// downstream requests and retries of those requests. The value may include ASCII alphanumerics and any of following
	// segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024 bytes.
	// The value is considered invalid and must be ignored if that value includes any other character or is longer than
	// 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XCorrelationID *string `json:"x-correlation-id,omitempty"`

	// The ID of the billing account of the tagged resource. It is a required parameter if `tag_type` is set to `service`.
	// Otherwise, it is inferred from the authorization IAM token.
	AccountID *string `json:"account_id,omitempty"`

	// The type of the tag. Supported values are `user`, `service` and `access`. `service` and `access` are not supported
	// for IMS resources.
	TagType *string `json:"tag_type,omitempty"`

	// Flag to request replacement of all attached tags. Set 'true' if you want to replace all the list of tags attached to
	// the resource. Default value is false.
	Replace *bool `json:"replace,omitempty"`

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

type CreateTagOptions struct {
	// An array of tag names to create.
	TagNames []string `json:"tag_names" validate:"required"`

	// An alphanumeric string that is used to trace the request. The value  may include ASCII alphanumerics and any of
	// following segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024
	// bytes. The value is considered invalid and must be ignored if that value includes any other character or is longer
	// than 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XRequestID *string `json:"x-request-id,omitempty"`

	// An alphanumeric string that is used to trace the request as a part of a larger context: the same value is used for
	// downstream requests and retries of those requests. The value may include ASCII alphanumerics and any of following
	// segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024 bytes.
	// The value is considered invalid and must be ignored if that value includes any other character or is longer than
	// 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XCorrelationID *string `json:"x-correlation-id,omitempty"`

	// The ID of the billing account where the tag must be created.
	AccountID *string `json:"account_id,omitempty"`

	// The type of the tags you want to create. The only allowed value is `access`.
	TagType *string `json:"tag_type,omitempty"`

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

type CreateTagResults struct {
	// Array of results of a create_tag request.
	Results []CreateTagResultsResultsItem `json:"results,omitempty"`
}

type CreateTagResultsResultsItem struct {
	// The name of the tag created.
	TagName *string `json:"tag_name,omitempty"`

	// true if the tag was not created (for example, the tag already exists).
	IsError *bool `json:"is_error,omitempty"`
}

type DeleteTagAllOptions struct {
	// An alphanumeric string that is used to trace the request. The value  may include ASCII alphanumerics and any of
	// following segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024
	// bytes. The value is considered invalid and must be ignored if that value includes any other character or is longer
	// than 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XRequestID *string `json:"x-request-id,omitempty"`

	// An alphanumeric string that is used to trace the request as a part of a larger context: the same value is used for
	// downstream requests and retries of those requests. The value may include ASCII alphanumerics and any of following
	// segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024 bytes.
	// The value is considered invalid and must be ignored if that value includes any other character or is longer than
	// 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XCorrelationID *string `json:"x-correlation-id,omitempty"`

	// Select a provider. Supported values are `ghost` and `ims`.
	Providers *string `json:"providers,omitempty"`

	// The ID of the billing account to delete the tags for. If it is not set, then it is taken from the authorization
	// token. It is a required parameter if `tag_type` is set to `service`.
	AccountID *string `json:"account_id,omitempty"`

	// The type of the tag. Supported values are `user`, `service` and `access`. `service` and `access` are not supported
	// for IMS resources (`providers` parameter set to `ims`).
	TagType *string `json:"tag_type,omitempty"`

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

type DeleteTagOptions struct {
	// The name of tag to be deleted.
	TagName *string `json:"tag_name" validate:"required,ne="`

	// An alphanumeric string that is used to trace the request. The value  may include ASCII alphanumerics and any of
	// following segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024
	// bytes. The value is considered invalid and must be ignored if that value includes any other character or is longer
	// than 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XRequestID *string `json:"x-request-id,omitempty"`

	// An alphanumeric string that is used to trace the request as a part of a larger context: the same value is used for
	// downstream requests and retries of those requests. The value may include ASCII alphanumerics and any of following
	// segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024 bytes.
	// The value is considered invalid and must be ignored if that value includes any other character or is longer than
	// 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XCorrelationID *string `json:"x-correlation-id,omitempty"`

	// Select a provider. Supported values are `ghost` and `ims`. To delete tags both in Global Search and Tagging and in
	// IMS, use `ghost,ims`.
	Providers []string `json:"providers,omitempty"`

	// The ID of the billing account to delete the tag for. It is a required parameter if `tag_type` is set to `service`,
	// otherwise it is inferred from the authorization IAM token.
	AccountID *string `json:"account_id,omitempty"`

	// The type of the tag. Supported values are `user`, `service` and `access`. `service` and `access` are not supported
	// for IMS resources (`providers` parameter set to `ims`).
	TagType *string `json:"tag_type,omitempty"`

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

type DeleteTagResults struct {
	// Array of results of a delete_tag request.
	Results []DeleteTagResultsItem `json:"results,omitempty"`
}

type DeleteTagResultsItem struct {
	// The provider of the tag.
	Provider *string `json:"provider,omitempty"`

	// It is `true` if the operation exits with an error (for example, the tag does not exist).
	IsError *bool `json:"is_error,omitempty"`
	// contains filtered or unexported fields
}

type DeleteTagsResult struct {
	// The number of tags that have been deleted.
	TotalCount *int64 `json:"total_count,omitempty"`

	// It is set to true if there is at least one tag operation in error.
	Errors *bool `json:"errors,omitempty"`

	// The list of tag operation results.
	Items []DeleteTagsResultItem `json:"items,omitempty"`
}

type DeleteTagsResultItem struct {
	// The name of the deleted tag.
	TagName *string `json:"tag_name,omitempty"`

	// true if the tag was not deleted.
	IsError *bool `json:"is_error,omitempty"`
}

type DetachTagOptions struct {
	// List of resources on which the tag or tags are detached.
	Resources []Resource `json:"resources" validate:"required"`

	// The name of the tag to detach.
	TagName *string `json:"tag_name,omitempty"`

	// An array of tag names to detach.
	TagNames []string `json:"tag_names,omitempty"`

	// An alphanumeric string that is used to trace the request. The value  may include ASCII alphanumerics and any of
	// following segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024
	// bytes. The value is considered invalid and must be ignored if that value includes any other character or is longer
	// than 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XRequestID *string `json:"x-request-id,omitempty"`

	// An alphanumeric string that is used to trace the request as a part of a larger context: the same value is used for
	// downstream requests and retries of those requests. The value may include ASCII alphanumerics and any of following
	// segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024 bytes.
	// The value is considered invalid and must be ignored if that value includes any other character or is longer than
	// 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XCorrelationID *string `json:"x-correlation-id,omitempty"`

	// The ID of the billing account of the untagged resource. It is a required parameter if `tag_type` is set to
	// `service`, otherwise it is inferred from the authorization IAM token.
	AccountID *string `json:"account_id,omitempty"`

	// The type of the tag. Supported values are `user`, `service` and `access`. `service` and `access` are not supported
	// for IMS resources.
	TagType *string `json:"tag_type,omitempty"`

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

type GlobalTaggingV1 struct {
	Service *core.BaseService
}

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

type ListTagsOptions struct {
	// An alphanumeric string that is used to trace the request. The value  may include ASCII alphanumerics and any of
	// following segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024
	// bytes. The value is considered invalid and must be ignored if that value includes any other character or is longer
	// than 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XRequestID *string `json:"x-request-id,omitempty"`

	// An alphanumeric string that is used to trace the request as a part of a larger context: the same value is used for
	// downstream requests and retries of those requests. The value may include ASCII alphanumerics and any of following
	// segment separators: space ( ), comma (,), hyphen, (-), and underscore (_) and may have a length up to 1024 bytes.
	// The value is considered invalid and must be ignored if that value includes any other character or is longer than
	// 1024 bytes or is fewer than 8 characters. If not specified or invalid, it is automatically replaced by a random
	// (version 4) UUID.
	XCorrelationID *string `json:"x-correlation-id,omitempty"`

	// The ID of the billing account to list the tags for. If it is not set, then it is taken from the authorization token.
	// This parameter is required if `tag_type` is set to `service`.
	AccountID *string `json:"account_id,omitempty"`

	// The type of the tag you want to list. Supported values are `user`, `service` and `access`.
	TagType *string `json:"tag_type,omitempty"`

	// If set to `true`, this query returns the provider, `ghost`, `ims` or `ghost,ims`, where the tag exists and the
	// number of attached resources.
	FullData *bool `json:"full_data,omitempty"`

	// Select a provider. Supported values are `ghost` and `ims`. To list both Global Search and Tagging tags and
	// infrastructure tags, use `ghost,ims`. `service` and `access` tags can only be attached to resources that are
	// onboarded to Global Search and Tagging, so you should not set this parameter to list them.
	Providers []string `json:"providers,omitempty"`

	// If you want to return only the list of tags that are attached to a specified resource, pass the ID of the resource
	// on this parameter. For resources that are onboarded to Global Search and Tagging, the resource ID is the CRN; for
	// IMS resources, it is the IMS ID. When using this parameter, you must specify the appropriate provider (`ims` or
	// `ghost`).
	AttachedTo *string `json:"attached_to,omitempty"`

	// The offset is the index of the item from which you want to start returning data from.
	Offset *int64 `json:"offset,omitempty"`

	// The number of tags to return.
	Limit *int64 `json:"limit,omitempty"`

	// The timeout in milliseconds, bounds the request to run within the specified time value. It returns the accumulated
	// results until time runs out.
	Timeout *int64 `json:"timeout,omitempty"`

	// Order the output by tag name.
	OrderByName *string `json:"order_by_name,omitempty"`

	// Filter on attached tags. If `true`, it returns only tags that are attached to one or more resources. If `false`, it
	// returns all tags.
	AttachedOnly *bool `json:"attached_only,omitempty"`

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

type Resource struct {
	// The CRN or IMS ID of the resource.
	ResourceID *string `json:"resource_id" validate:"required"`

	// The IMS resource type of the resource.
	ResourceType *string `json:"resource_type,omitempty"`
}

type Tag struct {
	// The name of the tag.
	Name *string `json:"name" validate:"required"`
}

type TagList struct {
	// Set the occurrences of the total tags that are associated with this account.
	TotalCount *int64 `json:"total_count,omitempty"`

	// The offset at which tags are returned.
	Offset *int64 `json:"offset,omitempty"`

	// The number of tags requested to be returned.
	Limit *int64 `json:"limit,omitempty"`

	// Array of output results.
	Items []Tag `json:"items,omitempty"`
}

type TagResults struct {
	// Array of results of an attach_tag or detach_tag request.
	Results []TagResultsItem `json:"results,omitempty"`
}

type TagResultsItem struct {
	// The CRN or IMS ID of the resource.
	ResourceID *string `json:"resource_id" validate:"required"`

	// It is `true` if the operation exits with an error.
	IsError *bool `json:"is_error,omitempty"`
}