schemaregistryv1

package
v1.4.1 Latest Latest
Warning

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

Go to latest
Published: Oct 16, 2023 License: Apache-2.0 Imports: 8 Imported by: 2

Documentation

Overview

Package schemaregistryv1 : Operations and models for the SchemaregistryV1 service

Index

Constants

View Source
const (
	CreateSchemaRuleOptionsConfigBackwardConst           = "BACKWARD"
	CreateSchemaRuleOptionsConfigBackwardTransitiveConst = "BACKWARD_TRANSITIVE"
	CreateSchemaRuleOptionsConfigForwardConst            = "FORWARD"
	CreateSchemaRuleOptionsConfigForwardTransitiveConst  = "FORWARD_TRANSITIVE"
	CreateSchemaRuleOptionsConfigFullConst               = "FULL"
	CreateSchemaRuleOptionsConfigFullTransitiveConst     = "FULL_TRANSITIVE"
	CreateSchemaRuleOptionsConfigNoneConst               = "NONE"
)

Constants associated with the CreateSchemaRuleOptions.Config property. The configuration value for the rule. Which values are valid depends on the value of this object's `type` property.

View Source
const (
	SetSchemaStateOptionsStateDisabledConst = "DISABLED"
	SetSchemaStateOptionsStateEnabledConst  = "ENABLED"
)

Constants associated with the SetSchemaStateOptions.State property. The state of the schema or schema version.

View Source
const (
	SetSchemaVersionStateOptionsStateDisabledConst = "DISABLED"
	SetSchemaVersionStateOptionsStateEnabledConst  = "ENABLED"
)

Constants associated with the SetSchemaVersionStateOptions.State property. The state of the schema or schema version.

View Source
const (
	UpdateGlobalRuleOptionsConfigBackwardConst           = "BACKWARD"
	UpdateGlobalRuleOptionsConfigBackwardTransitiveConst = "BACKWARD_TRANSITIVE"
	UpdateGlobalRuleOptionsConfigForwardConst            = "FORWARD"
	UpdateGlobalRuleOptionsConfigForwardTransitiveConst  = "FORWARD_TRANSITIVE"
	UpdateGlobalRuleOptionsConfigFullConst               = "FULL"
	UpdateGlobalRuleOptionsConfigFullTransitiveConst     = "FULL_TRANSITIVE"
	UpdateGlobalRuleOptionsConfigNoneConst               = "NONE"
)

Constants associated with the UpdateGlobalRuleOptions.Config property. The configuration value for the rule. Which values are valid depends on the value of this object's `type` property.

View Source
const (
	UpdateSchemaRuleOptionsConfigBackwardConst           = "BACKWARD"
	UpdateSchemaRuleOptionsConfigBackwardTransitiveConst = "BACKWARD_TRANSITIVE"
	UpdateSchemaRuleOptionsConfigForwardConst            = "FORWARD"
	UpdateSchemaRuleOptionsConfigForwardTransitiveConst  = "FORWARD_TRANSITIVE"
	UpdateSchemaRuleOptionsConfigFullConst               = "FULL"
	UpdateSchemaRuleOptionsConfigFullTransitiveConst     = "FULL_TRANSITIVE"
	UpdateSchemaRuleOptionsConfigNoneConst               = "NONE"
)

Constants associated with the UpdateSchemaRuleOptions.Config property. The configuration value for the rule. Which values are valid depends on the value of this object's `type` property.

View Source
const (
	RuleConfigBackwardConst           = "BACKWARD"
	RuleConfigBackwardTransitiveConst = "BACKWARD_TRANSITIVE"
	RuleConfigForwardConst            = "FORWARD"
	RuleConfigForwardTransitiveConst  = "FORWARD_TRANSITIVE"
	RuleConfigFullConst               = "FULL"
	RuleConfigFullTransitiveConst     = "FULL_TRANSITIVE"
	RuleConfigNoneConst               = "NONE"
)

Constants associated with the Rule.Config property. The configuration value for the rule. Which values are valid depends on the value of this object's `type` property.

View Source
const (
	CreateSchemaRuleOptionsTypeCompatibilityConst = "COMPATIBILITY"
)

Constants associated with the CreateSchemaRuleOptions.Type property. The type of the rule. Currently only one type is supported (`COMPATIBILITY`).

View Source
const DefaultServiceName = "schemaregistry"

DefaultServiceName is the default key used to find external configuration information.

View Source
const (
	DeleteSchemaRuleOptionsRuleCompatibilityConst = "COMPATIBILITY"
)

Constants associated with the DeleteSchemaRuleOptions.Rule property. The type of rule to delete. Currently only the value that can be specified is `COMPATIBILITY`.

View Source
const (
	GetGlobalRuleOptionsRuleCompatibilityConst = "COMPATIBILITY"
)

Constants associated with the GetGlobalRuleOptions.Rule property. The type of the global rule to retrieve. Currently only `COMPATIBILITY` is supported.

View Source
const (
	GetSchemaRuleOptionsRuleCompatibilityConst = "COMPATIBILITY"
)

Constants associated with the GetSchemaRuleOptions.Rule property. The type of rule to retrieve. Currently only the value that can be specified is `COMPATIBILITY`.

View Source
const (
	RuleTypeCompatibilityConst = "COMPATIBILITY"
)

Constants associated with the Rule.Type property. The type of the rule. Currently only one type is supported (`COMPATIBILITY`).

View Source
const (
	UpdateGlobalRuleOptionsRuleCompatibilityConst = "COMPATIBILITY"
)

Constants associated with the UpdateGlobalRuleOptions.Rule property. The type of the global rule to update. Currently only `COMPATIBILITY` is supported.

View Source
const (
	UpdateGlobalRuleOptionsTypeCompatibilityConst = "COMPATIBILITY"
)

Constants associated with the UpdateGlobalRuleOptions.Type property. The type of the rule. Currently only one type is supported (`COMPATIBILITY`).

View Source
const (
	UpdateSchemaRuleOptionsRuleCompatibilityConst = "COMPATIBILITY"
)

Constants associated with the UpdateSchemaRuleOptions.Rule property. The type of rule to update. Currently only the value that can be specified is `COMPATIBILITY`.

View Source
const (
	UpdateSchemaRuleOptionsTypeCompatibilityConst = "COMPATIBILITY"
)

Constants associated with the UpdateSchemaRuleOptions.Type property. The type of the rule. Currently only one type is supported (`COMPATIBILITY`).

Variables

This section is empty.

Functions

func GetServiceURLForRegion

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalAvroSchema added in v1.4.1

func UnmarshalAvroSchema(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAvroSchema unmarshals an instance of AvroSchema from the specified map of raw messages.

func UnmarshalRule

func UnmarshalRule(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRule unmarshals an instance of Rule from the specified map of raw messages.

func UnmarshalSchemaMetadata

func UnmarshalSchemaMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSchemaMetadata unmarshals an instance of SchemaMetadata from the specified map of raw messages.

Types

type AvroSchema added in v1.4.1

type AvroSchema struct {
	// The AVRO schema.
	Schema map[string]interface{} `json:"schema,omitempty"`
}

AvroSchema : AvroSchema struct

type CreateSchemaOptions

type CreateSchemaOptions struct {
	// The AVRO schema.
	Schema map[string]interface{} `json:"schema,omitempty"`

	// The name to assign to the new schema. This must be unique. If this value is not specified then a UUID is used.
	XRegistryArtifactID *string `json:"X-Registry-ArtifactId,omitempty"`

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

CreateSchemaOptions : The CreateSchema options.

func (*CreateSchemaOptions) SetHeaders

func (options *CreateSchemaOptions) SetHeaders(param map[string]string) *CreateSchemaOptions

SetHeaders : Allow user to set Headers

func (*CreateSchemaOptions) SetSchema

func (_options *CreateSchemaOptions) SetSchema(schema map[string]interface{}) *CreateSchemaOptions

SetSchema : Allow user to set Schema

func (*CreateSchemaOptions) SetXRegistryArtifactID added in v1.4.1

func (_options *CreateSchemaOptions) SetXRegistryArtifactID(xRegistryArtifactID string) *CreateSchemaOptions

SetXRegistryArtifactID : Allow user to set XRegistryArtifactID

type CreateSchemaRuleOptions

type CreateSchemaRuleOptions struct {
	// The ID of the schema that the rule is to be associated with.
	ID *string `json:"id" validate:"required,ne="`

	// The type of the rule. Currently only one type is supported (`COMPATIBILITY`).
	Type *string `json:"type" validate:"required"`

	// The configuration value for the rule. Which values are valid depends on the value of this object's `type` property.
	Config *string `json:"config" validate:"required"`

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

CreateSchemaRuleOptions : The CreateSchemaRule options.

func (*CreateSchemaRuleOptions) SetConfig

func (_options *CreateSchemaRuleOptions) SetConfig(config string) *CreateSchemaRuleOptions

SetConfig : Allow user to set Config

func (*CreateSchemaRuleOptions) SetHeaders

func (options *CreateSchemaRuleOptions) SetHeaders(param map[string]string) *CreateSchemaRuleOptions

SetHeaders : Allow user to set Headers

func (*CreateSchemaRuleOptions) SetID

SetID : Allow user to set ID

func (*CreateSchemaRuleOptions) SetType

func (_options *CreateSchemaRuleOptions) SetType(typeVar string) *CreateSchemaRuleOptions

SetType : Allow user to set Type

type CreateVersionOptions

type CreateVersionOptions struct {
	// A schema ID. This identifies the schema for which a new version will be created.
	ID *string `json:"id" validate:"required,ne="`

	// The AVRO schema.
	Schema map[string]interface{} `json:"schema,omitempty"`

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

CreateVersionOptions : The CreateVersion options.

func (*CreateVersionOptions) SetHeaders

func (options *CreateVersionOptions) SetHeaders(param map[string]string) *CreateVersionOptions

SetHeaders : Allow user to set Headers

func (*CreateVersionOptions) SetID

func (_options *CreateVersionOptions) SetID(id string) *CreateVersionOptions

SetID : Allow user to set ID

func (*CreateVersionOptions) SetSchema

func (_options *CreateVersionOptions) SetSchema(schema map[string]interface{}) *CreateVersionOptions

SetSchema : Allow user to set Schema

type DeleteSchemaOptions

type DeleteSchemaOptions struct {
	// The ID of the schema to delete.
	ID *string `json:"id" validate:"required,ne="`

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

DeleteSchemaOptions : The DeleteSchema options.

func (*DeleteSchemaOptions) SetHeaders

func (options *DeleteSchemaOptions) SetHeaders(param map[string]string) *DeleteSchemaOptions

SetHeaders : Allow user to set Headers

func (*DeleteSchemaOptions) SetID

func (_options *DeleteSchemaOptions) SetID(id string) *DeleteSchemaOptions

SetID : Allow user to set ID

type DeleteSchemaRuleOptions

type DeleteSchemaRuleOptions struct {
	// The ID of the schema that the rule is to be deleted from.
	ID *string `json:"id" validate:"required,ne="`

	// The type of rule to delete. Currently only the value that can be specified is `COMPATIBILITY`.
	Rule *string `json:"rule" validate:"required,ne="`

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

DeleteSchemaRuleOptions : The DeleteSchemaRule options.

func (*DeleteSchemaRuleOptions) SetHeaders

func (options *DeleteSchemaRuleOptions) SetHeaders(param map[string]string) *DeleteSchemaRuleOptions

SetHeaders : Allow user to set Headers

func (*DeleteSchemaRuleOptions) SetID

SetID : Allow user to set ID

func (*DeleteSchemaRuleOptions) SetRule

func (_options *DeleteSchemaRuleOptions) SetRule(rule string) *DeleteSchemaRuleOptions

SetRule : Allow user to set Rule

type DeleteVersionOptions

type DeleteVersionOptions struct {
	// A schema ID that identifies the schema to delete a version from.
	ID *string `json:"id" validate:"required,ne="`

	// The schema version number to delete.
	Version *int64 `json:"version" validate:"required"`

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

DeleteVersionOptions : The DeleteVersion options.

func (*DeleteVersionOptions) SetHeaders

func (options *DeleteVersionOptions) SetHeaders(param map[string]string) *DeleteVersionOptions

SetHeaders : Allow user to set Headers

func (*DeleteVersionOptions) SetID

func (_options *DeleteVersionOptions) SetID(id string) *DeleteVersionOptions

SetID : Allow user to set ID

func (*DeleteVersionOptions) SetVersion

func (_options *DeleteVersionOptions) SetVersion(version int64) *DeleteVersionOptions

SetVersion : Allow user to set Version

type GetGlobalRuleOptions

type GetGlobalRuleOptions struct {
	// The type of the global rule to retrieve. Currently only `COMPATIBILITY` is supported.
	Rule *string `json:"rule" validate:"required,ne="`

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

GetGlobalRuleOptions : The GetGlobalRule options.

func (*GetGlobalRuleOptions) SetHeaders

func (options *GetGlobalRuleOptions) SetHeaders(param map[string]string) *GetGlobalRuleOptions

SetHeaders : Allow user to set Headers

func (*GetGlobalRuleOptions) SetRule

func (_options *GetGlobalRuleOptions) SetRule(rule string) *GetGlobalRuleOptions

SetRule : Allow user to set Rule

type GetLatestSchemaOptions

type GetLatestSchemaOptions struct {
	// The ID of a schema.
	ID *string `json:"id" validate:"required,ne="`

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

GetLatestSchemaOptions : The GetLatestSchema options.

func (*GetLatestSchemaOptions) SetHeaders

func (options *GetLatestSchemaOptions) SetHeaders(param map[string]string) *GetLatestSchemaOptions

SetHeaders : Allow user to set Headers

func (*GetLatestSchemaOptions) SetID

SetID : Allow user to set ID

type GetSchemaRuleOptions

type GetSchemaRuleOptions struct {
	// The ID of the schema to retrieve the rule for.
	ID *string `json:"id" validate:"required,ne="`

	// The type of rule to retrieve. Currently only the value that can be specified is `COMPATIBILITY`.
	Rule *string `json:"rule" validate:"required,ne="`

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

GetSchemaRuleOptions : The GetSchemaRule options.

func (*GetSchemaRuleOptions) SetHeaders

func (options *GetSchemaRuleOptions) SetHeaders(param map[string]string) *GetSchemaRuleOptions

SetHeaders : Allow user to set Headers

func (*GetSchemaRuleOptions) SetID

func (_options *GetSchemaRuleOptions) SetID(id string) *GetSchemaRuleOptions

SetID : Allow user to set ID

func (*GetSchemaRuleOptions) SetRule

func (_options *GetSchemaRuleOptions) SetRule(rule string) *GetSchemaRuleOptions

SetRule : Allow user to set Rule

type GetVersionOptions

type GetVersionOptions struct {
	// The schema ID identifying which schema to return a version from.
	ID *string `json:"id" validate:"required,ne="`

	// The version number that identifies the particular schema version to return.
	Version *int64 `json:"version" validate:"required"`

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

GetVersionOptions : The GetVersion options.

func (*GetVersionOptions) SetHeaders

func (options *GetVersionOptions) SetHeaders(param map[string]string) *GetVersionOptions

SetHeaders : Allow user to set Headers

func (*GetVersionOptions) SetID

func (_options *GetVersionOptions) SetID(id string) *GetVersionOptions

SetID : Allow user to set ID

func (*GetVersionOptions) SetVersion

func (_options *GetVersionOptions) SetVersion(version int64) *GetVersionOptions

SetVersion : Allow user to set Version

type ListSchemasOptions

type ListSchemasOptions struct {
	// format of the response to be returned, allowed values are 'string' and 'object'.
	Jsonformat *string `json:"jsonformat,omitempty"`

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

ListSchemasOptions : The ListSchemas options.

func (*ListSchemasOptions) SetHeaders

func (options *ListSchemasOptions) SetHeaders(param map[string]string) *ListSchemasOptions

SetHeaders : Allow user to set Headers

func (*ListSchemasOptions) SetJsonformat added in v1.4.0

func (_options *ListSchemasOptions) SetJsonformat(jsonformat string) *ListSchemasOptions

SetJsonformat : Allow user to set Jsonformat

type ListVersionsOptions

type ListVersionsOptions struct {
	// The schema ID for which the list of versions will be returned.
	ID *string `json:"id" validate:"required,ne="`

	// format of the response to be returned, allowed values are 'number' and 'object'.
	Jsonformat *string `json:"jsonformat,omitempty"`

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

ListVersionsOptions : The ListVersions options.

func (*ListVersionsOptions) SetHeaders

func (options *ListVersionsOptions) SetHeaders(param map[string]string) *ListVersionsOptions

SetHeaders : Allow user to set Headers

func (*ListVersionsOptions) SetID

func (_options *ListVersionsOptions) SetID(id string) *ListVersionsOptions

SetID : Allow user to set ID

func (*ListVersionsOptions) SetJsonformat added in v1.4.0

func (_options *ListVersionsOptions) SetJsonformat(jsonformat string) *ListVersionsOptions

SetJsonformat : Allow user to set Jsonformat

type Rule

type Rule struct {
	// The type of the rule. Currently only one type is supported (`COMPATIBILITY`).
	Type *string `json:"type" validate:"required"`

	// The configuration value for the rule. Which values are valid depends on the value of this object's `type` property.
	Config *string `json:"config" validate:"required"`
}

Rule : Rules define constraints on whether the schema registry will accept a new version of a schema.

type SchemaMetadata

type SchemaMetadata struct {
	// Creation timestamp of the schema in UNIX epoc format.
	CreatedOn *int64 `json:"createdOn" validate:"required"`

	// Globally unique ID assigned to the initial version of the schema.
	GlobalID *int64 `json:"globalId" validate:"required"`

	// The ID of the schema. This is either taken from the `X-Registry-ArtifactId` header when the request is made to
	// create the schema or is an automatically assigned UUID value.
	ID *string `json:"id" validate:"required"`

	// Last modification timestamp of the schema in UNIX epoc format.
	ModifiedOn *int64 `json:"modifiedOn" validate:"required"`

	// Type of the schema. Always the string `AVRO`.
	Type *string `json:"type" validate:"required"`

	// Version number assigned to this version of the schema.
	Version *int64 `json:"version" validate:"required"`
}

SchemaMetadata : Information about a schema version.

type SchemaregistryV1

type SchemaregistryV1 struct {
	Service *core.BaseService
}

SchemaregistryV1 : IBM Event Streams schema registry management

API Version: 1.3.0

func NewSchemaregistryV1

func NewSchemaregistryV1(options *SchemaregistryV1Options) (service *SchemaregistryV1, err error)

NewSchemaregistryV1 : constructs an instance of SchemaregistryV1 with passed in options.

func NewSchemaregistryV1UsingExternalConfig

func NewSchemaregistryV1UsingExternalConfig(options *SchemaregistryV1Options) (schemaregistry *SchemaregistryV1, err error)

NewSchemaregistryV1UsingExternalConfig : constructs an instance of SchemaregistryV1 with passed in options and external configuration.

func (*SchemaregistryV1) Clone

func (schemaregistry *SchemaregistryV1) Clone() *SchemaregistryV1

Clone makes a copy of "schemaregistry" suitable for processing requests.

func (*SchemaregistryV1) CreateSchema

func (schemaregistry *SchemaregistryV1) CreateSchema(createSchemaOptions *CreateSchemaOptions) (result *SchemaMetadata, response *core.DetailedResponse, err error)

CreateSchema : Create a new schema Create a new schema and populate it with an initial schema version containing the AVRO document in the request body.

func (*SchemaregistryV1) CreateSchemaRule

func (schemaregistry *SchemaregistryV1) CreateSchemaRule(createSchemaRuleOptions *CreateSchemaRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

CreateSchemaRule : Create a schema rule Create a new rule that controls compatibility checks for a particular schema. Schema rules override the registries global compatibility rule setting.

func (*SchemaregistryV1) CreateSchemaRuleWithContext

func (schemaregistry *SchemaregistryV1) CreateSchemaRuleWithContext(ctx context.Context, createSchemaRuleOptions *CreateSchemaRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

CreateSchemaRuleWithContext is an alternate form of the CreateSchemaRule method which supports a Context parameter

func (*SchemaregistryV1) CreateSchemaWithContext

func (schemaregistry *SchemaregistryV1) CreateSchemaWithContext(ctx context.Context, createSchemaOptions *CreateSchemaOptions) (result *SchemaMetadata, response *core.DetailedResponse, err error)

CreateSchemaWithContext is an alternate form of the CreateSchema method which supports a Context parameter

func (*SchemaregistryV1) CreateVersion

func (schemaregistry *SchemaregistryV1) CreateVersion(createVersionOptions *CreateVersionOptions) (result *SchemaMetadata, response *core.DetailedResponse, err error)

CreateVersion : Create a new schema version Creates a new version of a schema using the AVRO schema supplied in the request body.

func (*SchemaregistryV1) CreateVersionWithContext

func (schemaregistry *SchemaregistryV1) CreateVersionWithContext(ctx context.Context, createVersionOptions *CreateVersionOptions) (result *SchemaMetadata, response *core.DetailedResponse, err error)

CreateVersionWithContext is an alternate form of the CreateVersion method which supports a Context parameter

func (*SchemaregistryV1) DeleteSchema

func (schemaregistry *SchemaregistryV1) DeleteSchema(deleteSchemaOptions *DeleteSchemaOptions) (response *core.DetailedResponse, err error)

DeleteSchema : Delete a schema Deletes a schema and all of its versions from the schema registry.

func (*SchemaregistryV1) DeleteSchemaRule

func (schemaregistry *SchemaregistryV1) DeleteSchemaRule(deleteSchemaRuleOptions *DeleteSchemaRuleOptions) (response *core.DetailedResponse, err error)

DeleteSchemaRule : Delete a schema rule Delete a rule that controls compatibility checks for a particular schema. After this operation completes the schema will be subject to compatibility checking defined by the global compatibility rule setting for the registry.

func (*SchemaregistryV1) DeleteSchemaRuleWithContext

func (schemaregistry *SchemaregistryV1) DeleteSchemaRuleWithContext(ctx context.Context, deleteSchemaRuleOptions *DeleteSchemaRuleOptions) (response *core.DetailedResponse, err error)

DeleteSchemaRuleWithContext is an alternate form of the DeleteSchemaRule method which supports a Context parameter

func (*SchemaregistryV1) DeleteSchemaWithContext

func (schemaregistry *SchemaregistryV1) DeleteSchemaWithContext(ctx context.Context, deleteSchemaOptions *DeleteSchemaOptions) (response *core.DetailedResponse, err error)

DeleteSchemaWithContext is an alternate form of the DeleteSchema method which supports a Context parameter

func (*SchemaregistryV1) DeleteVersion

func (schemaregistry *SchemaregistryV1) DeleteVersion(deleteVersionOptions *DeleteVersionOptions) (response *core.DetailedResponse, err error)

DeleteVersion : Delete a version of the schema Delete a version of the schema. If this was the only version of the schema then the whole schema will be deleted.

func (*SchemaregistryV1) DeleteVersionWithContext

func (schemaregistry *SchemaregistryV1) DeleteVersionWithContext(ctx context.Context, deleteVersionOptions *DeleteVersionOptions) (response *core.DetailedResponse, err error)

DeleteVersionWithContext is an alternate form of the DeleteVersion method which supports a Context parameter

func (*SchemaregistryV1) DisableRetries

func (schemaregistry *SchemaregistryV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*SchemaregistryV1) EnableRetries

func (schemaregistry *SchemaregistryV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*SchemaregistryV1) GetEnableGzipCompression

func (schemaregistry *SchemaregistryV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*SchemaregistryV1) GetGlobalRule

func (schemaregistry *SchemaregistryV1) GetGlobalRule(getGlobalRuleOptions *GetGlobalRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

GetGlobalRule : Retrieve the configuration for a global rule Retrieves the configuration for the specified global rule. The value of the global rule is used as the _default_ when a schema does not have a corresponding schema compatibility rule defined.

func (*SchemaregistryV1) GetGlobalRuleWithContext

func (schemaregistry *SchemaregistryV1) GetGlobalRuleWithContext(ctx context.Context, getGlobalRuleOptions *GetGlobalRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

GetGlobalRuleWithContext is an alternate form of the GetGlobalRule method which supports a Context parameter

func (*SchemaregistryV1) GetLatestSchema

func (schemaregistry *SchemaregistryV1) GetLatestSchema(getLatestSchemaOptions *GetLatestSchemaOptions) (result *AvroSchema, response *core.DetailedResponse, err error)

GetLatestSchema : Get the latest version of a schema Retrieves the lastest version of the specified schema.

func (*SchemaregistryV1) GetLatestSchemaWithContext

func (schemaregistry *SchemaregistryV1) GetLatestSchemaWithContext(ctx context.Context, getLatestSchemaOptions *GetLatestSchemaOptions) (result *AvroSchema, response *core.DetailedResponse, err error)

GetLatestSchemaWithContext is an alternate form of the GetLatestSchema method which supports a Context parameter

func (*SchemaregistryV1) GetSchemaRule

func (schemaregistry *SchemaregistryV1) GetSchemaRule(getSchemaRuleOptions *GetSchemaRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

GetSchemaRule : Get a schema rule configuration Retrieves the current configuration for a schema rule. If a schema rule exists then it overrides the corresponding global rule that would otherwise be applied.

func (*SchemaregistryV1) GetSchemaRuleWithContext

func (schemaregistry *SchemaregistryV1) GetSchemaRuleWithContext(ctx context.Context, getSchemaRuleOptions *GetSchemaRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

GetSchemaRuleWithContext is an alternate form of the GetSchemaRule method which supports a Context parameter

func (*SchemaregistryV1) GetServiceURL

func (schemaregistry *SchemaregistryV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*SchemaregistryV1) GetVersion

func (schemaregistry *SchemaregistryV1) GetVersion(getVersionOptions *GetVersionOptions) (result *AvroSchema, response *core.DetailedResponse, err error)

GetVersion : Get a version of the schema Retrieve a particular version of the schema.

func (*SchemaregistryV1) GetVersionWithContext

func (schemaregistry *SchemaregistryV1) GetVersionWithContext(ctx context.Context, getVersionOptions *GetVersionOptions) (result *AvroSchema, response *core.DetailedResponse, err error)

GetVersionWithContext is an alternate form of the GetVersion method which supports a Context parameter

func (*SchemaregistryV1) ListSchemas

func (schemaregistry *SchemaregistryV1) ListSchemas(listSchemasOptions *ListSchemasOptions) (result []string, response *core.DetailedResponse, err error)

ListSchemas : List schema IDs Returns an array containing the schema IDs of all of the schemas that are stored in the registry.

func (*SchemaregistryV1) ListSchemasWithContext

func (schemaregistry *SchemaregistryV1) ListSchemasWithContext(ctx context.Context, listSchemasOptions *ListSchemasOptions) (result []string, response *core.DetailedResponse, err error)

ListSchemasWithContext is an alternate form of the ListSchemas method which supports a Context parameter

func (*SchemaregistryV1) ListVersions

func (schemaregistry *SchemaregistryV1) ListVersions(listVersionsOptions *ListVersionsOptions) (result []int64, response *core.DetailedResponse, err error)

ListVersions : List the versions of a schema Returns an array containing the version numbers of all of the versions of the specified schema.

func (*SchemaregistryV1) ListVersionsWithContext

func (schemaregistry *SchemaregistryV1) ListVersionsWithContext(ctx context.Context, listVersionsOptions *ListVersionsOptions) (result []int64, response *core.DetailedResponse, err error)

ListVersionsWithContext is an alternate form of the ListVersions method which supports a Context parameter

func (*SchemaregistryV1) NewCreateSchemaOptions

func (*SchemaregistryV1) NewCreateSchemaOptions() *CreateSchemaOptions

NewCreateSchemaOptions : Instantiate CreateSchemaOptions

func (*SchemaregistryV1) NewCreateSchemaRuleOptions

func (*SchemaregistryV1) NewCreateSchemaRuleOptions(id string, typeVar string, config string) *CreateSchemaRuleOptions

NewCreateSchemaRuleOptions : Instantiate CreateSchemaRuleOptions

func (*SchemaregistryV1) NewCreateVersionOptions

func (*SchemaregistryV1) NewCreateVersionOptions(id string) *CreateVersionOptions

NewCreateVersionOptions : Instantiate CreateVersionOptions

func (*SchemaregistryV1) NewDeleteSchemaOptions

func (*SchemaregistryV1) NewDeleteSchemaOptions(id string) *DeleteSchemaOptions

NewDeleteSchemaOptions : Instantiate DeleteSchemaOptions

func (*SchemaregistryV1) NewDeleteSchemaRuleOptions

func (*SchemaregistryV1) NewDeleteSchemaRuleOptions(id string, rule string) *DeleteSchemaRuleOptions

NewDeleteSchemaRuleOptions : Instantiate DeleteSchemaRuleOptions

func (*SchemaregistryV1) NewDeleteVersionOptions

func (*SchemaregistryV1) NewDeleteVersionOptions(id string, version int64) *DeleteVersionOptions

NewDeleteVersionOptions : Instantiate DeleteVersionOptions

func (*SchemaregistryV1) NewGetGlobalRuleOptions

func (*SchemaregistryV1) NewGetGlobalRuleOptions(rule string) *GetGlobalRuleOptions

NewGetGlobalRuleOptions : Instantiate GetGlobalRuleOptions

func (*SchemaregistryV1) NewGetLatestSchemaOptions

func (*SchemaregistryV1) NewGetLatestSchemaOptions(id string) *GetLatestSchemaOptions

NewGetLatestSchemaOptions : Instantiate GetLatestSchemaOptions

func (*SchemaregistryV1) NewGetSchemaRuleOptions

func (*SchemaregistryV1) NewGetSchemaRuleOptions(id string, rule string) *GetSchemaRuleOptions

NewGetSchemaRuleOptions : Instantiate GetSchemaRuleOptions

func (*SchemaregistryV1) NewGetVersionOptions

func (*SchemaregistryV1) NewGetVersionOptions(id string, version int64) *GetVersionOptions

NewGetVersionOptions : Instantiate GetVersionOptions

func (*SchemaregistryV1) NewListSchemasOptions

func (*SchemaregistryV1) NewListSchemasOptions() *ListSchemasOptions

NewListSchemasOptions : Instantiate ListSchemasOptions

func (*SchemaregistryV1) NewListVersionsOptions

func (*SchemaregistryV1) NewListVersionsOptions(id string) *ListVersionsOptions

NewListVersionsOptions : Instantiate ListVersionsOptions

func (*SchemaregistryV1) NewRule

func (*SchemaregistryV1) NewRule(typeVar string, config string) (_model *Rule, err error)

NewRule : Instantiate Rule (Generic Model Constructor)

func (*SchemaregistryV1) NewSetSchemaStateOptions added in v1.4.0

func (*SchemaregistryV1) NewSetSchemaStateOptions(id string, state string) *SetSchemaStateOptions

NewSetSchemaStateOptions : Instantiate SetSchemaStateOptions

func (*SchemaregistryV1) NewSetSchemaVersionStateOptions added in v1.4.0

func (*SchemaregistryV1) NewSetSchemaVersionStateOptions(id string, version int64, state string) *SetSchemaVersionStateOptions

NewSetSchemaVersionStateOptions : Instantiate SetSchemaVersionStateOptions

func (*SchemaregistryV1) NewUpdateGlobalRuleOptions

func (*SchemaregistryV1) NewUpdateGlobalRuleOptions(rule string, typeVar string, config string) *UpdateGlobalRuleOptions

NewUpdateGlobalRuleOptions : Instantiate UpdateGlobalRuleOptions

func (*SchemaregistryV1) NewUpdateSchemaOptions

func (*SchemaregistryV1) NewUpdateSchemaOptions(id string) *UpdateSchemaOptions

NewUpdateSchemaOptions : Instantiate UpdateSchemaOptions

func (*SchemaregistryV1) NewUpdateSchemaRuleOptions

func (*SchemaregistryV1) NewUpdateSchemaRuleOptions(id string, rule string, typeVar string, config string) *UpdateSchemaRuleOptions

NewUpdateSchemaRuleOptions : Instantiate UpdateSchemaRuleOptions

func (*SchemaregistryV1) SetDefaultHeaders

func (schemaregistry *SchemaregistryV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*SchemaregistryV1) SetEnableGzipCompression

func (schemaregistry *SchemaregistryV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*SchemaregistryV1) SetSchemaState added in v1.4.0

func (schemaregistry *SchemaregistryV1) SetSchemaState(setSchemaStateOptions *SetSchemaStateOptions) (response *core.DetailedResponse, err error)

SetSchemaState : Set schema state Sets schema state.

func (*SchemaregistryV1) SetSchemaStateWithContext added in v1.4.0

func (schemaregistry *SchemaregistryV1) SetSchemaStateWithContext(ctx context.Context, setSchemaStateOptions *SetSchemaStateOptions) (response *core.DetailedResponse, err error)

SetSchemaStateWithContext is an alternate form of the SetSchemaState method which supports a Context parameter

func (*SchemaregistryV1) SetSchemaVersionState added in v1.4.0

func (schemaregistry *SchemaregistryV1) SetSchemaVersionState(setSchemaVersionStateOptions *SetSchemaVersionStateOptions) (response *core.DetailedResponse, err error)

SetSchemaVersionState : Set schema version state Sets schema version state.

func (*SchemaregistryV1) SetSchemaVersionStateWithContext added in v1.4.0

func (schemaregistry *SchemaregistryV1) SetSchemaVersionStateWithContext(ctx context.Context, setSchemaVersionStateOptions *SetSchemaVersionStateOptions) (response *core.DetailedResponse, err error)

SetSchemaVersionStateWithContext is an alternate form of the SetSchemaVersionState method which supports a Context parameter

func (*SchemaregistryV1) SetServiceURL

func (schemaregistry *SchemaregistryV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*SchemaregistryV1) UpdateGlobalRule

func (schemaregistry *SchemaregistryV1) UpdateGlobalRule(updateGlobalRuleOptions *UpdateGlobalRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

UpdateGlobalRule : Update the configuration for a global rule Update the configuration for the specified global rule. The value of the global rule is used as the _default_ when a schema does not have a corresponding schema compatibility rule defined.

func (*SchemaregistryV1) UpdateGlobalRuleWithContext

func (schemaregistry *SchemaregistryV1) UpdateGlobalRuleWithContext(ctx context.Context, updateGlobalRuleOptions *UpdateGlobalRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

UpdateGlobalRuleWithContext is an alternate form of the UpdateGlobalRule method which supports a Context parameter

func (*SchemaregistryV1) UpdateSchema

func (schemaregistry *SchemaregistryV1) UpdateSchema(updateSchemaOptions *UpdateSchemaOptions) (result *SchemaMetadata, response *core.DetailedResponse, err error)

UpdateSchema : Update a schema Updates a schema.

func (*SchemaregistryV1) UpdateSchemaRule

func (schemaregistry *SchemaregistryV1) UpdateSchemaRule(updateSchemaRuleOptions *UpdateSchemaRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

UpdateSchemaRule : Update the configuration of a schema rule Updates the configuration of an existing schema rule. The updated rule will be applied to the specified schema, overriding the value set for the corresponding global rule.

func (*SchemaregistryV1) UpdateSchemaRuleWithContext

func (schemaregistry *SchemaregistryV1) UpdateSchemaRuleWithContext(ctx context.Context, updateSchemaRuleOptions *UpdateSchemaRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

UpdateSchemaRuleWithContext is an alternate form of the UpdateSchemaRule method which supports a Context parameter

func (*SchemaregistryV1) UpdateSchemaWithContext

func (schemaregistry *SchemaregistryV1) UpdateSchemaWithContext(ctx context.Context, updateSchemaOptions *UpdateSchemaOptions) (result *SchemaMetadata, response *core.DetailedResponse, err error)

UpdateSchemaWithContext is an alternate form of the UpdateSchema method which supports a Context parameter

type SchemaregistryV1Options

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

SchemaregistryV1Options : Service options

type SetSchemaStateOptions added in v1.4.0

type SetSchemaStateOptions struct {
	// The ID of a schema.
	ID *string `json:"id" validate:"required,ne="`

	// The state of the schema or schema version.
	State *string `json:"state" validate:"required"`

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

SetSchemaStateOptions : The SetSchemaState options.

func (*SetSchemaStateOptions) SetHeaders added in v1.4.0

func (options *SetSchemaStateOptions) SetHeaders(param map[string]string) *SetSchemaStateOptions

SetHeaders : Allow user to set Headers

func (*SetSchemaStateOptions) SetID added in v1.4.0

func (_options *SetSchemaStateOptions) SetID(id string) *SetSchemaStateOptions

SetID : Allow user to set ID

func (*SetSchemaStateOptions) SetState added in v1.4.0

func (_options *SetSchemaStateOptions) SetState(state string) *SetSchemaStateOptions

SetState : Allow user to set State

type SetSchemaVersionStateOptions added in v1.4.0

type SetSchemaVersionStateOptions struct {
	// The ID of a schema.
	ID *string `json:"id" validate:"required,ne="`

	// The version number that identifies the particular schema version to return.
	Version *int64 `json:"version" validate:"required"`

	// The state of the schema or schema version.
	State *string `json:"state" validate:"required"`

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

SetSchemaVersionStateOptions : The SetSchemaVersionState options.

func (*SetSchemaVersionStateOptions) SetHeaders added in v1.4.0

SetHeaders : Allow user to set Headers

func (*SetSchemaVersionStateOptions) SetID added in v1.4.0

SetID : Allow user to set ID

func (*SetSchemaVersionStateOptions) SetState added in v1.4.0

SetState : Allow user to set State

func (*SetSchemaVersionStateOptions) SetVersion added in v1.4.0

func (_options *SetSchemaVersionStateOptions) SetVersion(version int64) *SetSchemaVersionStateOptions

SetVersion : Allow user to set Version

type UpdateGlobalRuleOptions

type UpdateGlobalRuleOptions struct {
	// The type of the global rule to update. Currently only `COMPATIBILITY` is supported.
	Rule *string `json:"rule" validate:"required,ne="`

	// The type of the rule. Currently only one type is supported (`COMPATIBILITY`).
	Type *string `json:"type" validate:"required"`

	// The configuration value for the rule. Which values are valid depends on the value of this object's `type` property.
	Config *string `json:"config" validate:"required"`

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

UpdateGlobalRuleOptions : The UpdateGlobalRule options.

func (*UpdateGlobalRuleOptions) SetConfig

func (_options *UpdateGlobalRuleOptions) SetConfig(config string) *UpdateGlobalRuleOptions

SetConfig : Allow user to set Config

func (*UpdateGlobalRuleOptions) SetHeaders

func (options *UpdateGlobalRuleOptions) SetHeaders(param map[string]string) *UpdateGlobalRuleOptions

SetHeaders : Allow user to set Headers

func (*UpdateGlobalRuleOptions) SetRule

func (_options *UpdateGlobalRuleOptions) SetRule(rule string) *UpdateGlobalRuleOptions

SetRule : Allow user to set Rule

func (*UpdateGlobalRuleOptions) SetType

func (_options *UpdateGlobalRuleOptions) SetType(typeVar string) *UpdateGlobalRuleOptions

SetType : Allow user to set Type

type UpdateSchemaOptions

type UpdateSchemaOptions struct {
	// The ID of the schema to update.
	ID *string `json:"id" validate:"required,ne="`

	// The AVRO schema.
	Schema map[string]interface{} `json:"schema,omitempty"`

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

UpdateSchemaOptions : The UpdateSchema options.

func (*UpdateSchemaOptions) SetHeaders

func (options *UpdateSchemaOptions) SetHeaders(param map[string]string) *UpdateSchemaOptions

SetHeaders : Allow user to set Headers

func (*UpdateSchemaOptions) SetID

func (_options *UpdateSchemaOptions) SetID(id string) *UpdateSchemaOptions

SetID : Allow user to set ID

func (*UpdateSchemaOptions) SetSchema

func (_options *UpdateSchemaOptions) SetSchema(schema map[string]interface{}) *UpdateSchemaOptions

SetSchema : Allow user to set Schema

type UpdateSchemaRuleOptions

type UpdateSchemaRuleOptions struct {
	// The ID of the schema for which to update the rule configuration.
	ID *string `json:"id" validate:"required,ne="`

	// The type of rule to update. Currently only the value that can be specified is `COMPATIBILITY`.
	Rule *string `json:"rule" validate:"required,ne="`

	// The type of the rule. Currently only one type is supported (`COMPATIBILITY`).
	Type *string `json:"type" validate:"required"`

	// The configuration value for the rule. Which values are valid depends on the value of this object's `type` property.
	Config *string `json:"config" validate:"required"`

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

UpdateSchemaRuleOptions : The UpdateSchemaRule options.

func (*UpdateSchemaRuleOptions) SetConfig

func (_options *UpdateSchemaRuleOptions) SetConfig(config string) *UpdateSchemaRuleOptions

SetConfig : Allow user to set Config

func (*UpdateSchemaRuleOptions) SetHeaders

func (options *UpdateSchemaRuleOptions) SetHeaders(param map[string]string) *UpdateSchemaRuleOptions

SetHeaders : Allow user to set Headers

func (*UpdateSchemaRuleOptions) SetID

SetID : Allow user to set ID

func (*UpdateSchemaRuleOptions) SetRule

func (_options *UpdateSchemaRuleOptions) SetRule(rule string) *UpdateSchemaRuleOptions

SetRule : Allow user to set Rule

func (*UpdateSchemaRuleOptions) SetType

func (_options *UpdateSchemaRuleOptions) SetType(typeVar string) *UpdateSchemaRuleOptions

SetType : Allow user to set Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL