Schemas class
Amazon EventBridge Schema Registry
Constructors
- Schemas({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createDiscoverer(
{required String sourceArn, String? description, Map< String, String> ? tags}) → Future<CreateDiscovererResponse> - Creates a discoverer.
-
createRegistry(
{required String registryName, String? description, Map< String, String> ? tags}) → Future<CreateRegistryResponse> - Creates a registry.
-
createSchema(
{required String content, required String registryName, required String schemaName, required Type type, String? description, Map< String, String> ? tags}) → Future<CreateSchemaResponse> - Creates a schema definition.
-
deleteDiscoverer(
{required String discovererId}) → Future< void> - Deletes a discoverer.
-
deleteRegistry(
{required String registryName}) → Future< void> - Deletes a Registry.
-
deleteResourcePolicy(
{String? registryName}) → Future< void> - Delete the resource-based policy attached to the specified registry.
-
deleteSchema(
{required String registryName, required String schemaName}) → Future< void> - Delete a schema definition.
-
deleteSchemaVersion(
{required String registryName, required String schemaName, required String schemaVersion}) → Future< void> - Delete the schema version definition
-
describeCodeBinding(
{required String language, required String registryName, required String schemaName, String? schemaVersion}) → Future< DescribeCodeBindingResponse> - Describe the code binding URI.
-
describeDiscoverer(
{required String discovererId}) → Future< DescribeDiscovererResponse> - Describes the discoverer.
-
describeRegistry(
{required String registryName}) → Future< DescribeRegistryResponse> - Describes the registry.
-
describeSchema(
{required String registryName, required String schemaName, String? schemaVersion}) → Future< DescribeSchemaResponse> - Retrieve the schema definition.
-
exportSchema(
{required String registryName, required String schemaName, required String type, String? schemaVersion}) → Future< ExportSchemaResponse> - May throw BadRequestException. May throw UnauthorizedException. May throw InternalServerErrorException. May throw ForbiddenException. May throw NotFoundException. May throw ServiceUnavailableException. May throw TooManyRequestsException.
-
getCodeBindingSource(
{required String language, required String registryName, required String schemaName, String? schemaVersion}) → Future< GetCodeBindingSourceResponse> - Get the code binding source URI.
-
getDiscoveredSchema(
{required List< String> events, required Type type}) → Future<GetDiscoveredSchemaResponse> - Get the discovered schema that was generated based on sampled events.
-
getResourcePolicy(
{String? registryName}) → Future< GetResourcePolicyResponse> - Retrieves the resource-based policy attached to a given registry.
-
listDiscoverers(
{String? discovererIdPrefix, int? limit, String? nextToken, String? sourceArnPrefix}) → Future< ListDiscoverersResponse> - List the discoverers.
-
listRegistries(
{int? limit, String? nextToken, String? registryNamePrefix, String? scope}) → Future< ListRegistriesResponse> - List the registries.
-
listSchemas(
{required String registryName, int? limit, String? nextToken, String? schemaNamePrefix}) → Future< ListSchemasResponse> - List the schemas.
-
listSchemaVersions(
{required String registryName, required String schemaName, int? limit, String? nextToken}) → Future< ListSchemaVersionsResponse> - Provides a list of the schema versions and related information.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Get tags for resource.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
putCodeBinding(
{required String language, required String registryName, required String schemaName, String? schemaVersion}) → Future< PutCodeBindingResponse> - Put code binding URI
-
putResourcePolicy(
{required Object policy, String? registryName, String? revisionId}) → Future< PutResourcePolicyResponse> - The name of the policy.
-
searchSchemas(
{required String keywords, required String registryName, int? limit, String? nextToken}) → Future< SearchSchemasResponse> - Search the schemas
-
startDiscoverer(
{required String discovererId}) → Future< StartDiscovererResponse> - Starts the discoverer
-
stopDiscoverer(
{required String discovererId}) → Future< StopDiscovererResponse> - Stops the discoverer
-
tagResource(
{required String resourceArn, required Map< String, String> tags}) → Future<void> - Add tags to a resource.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Removes tags from a resource.
-
updateDiscoverer(
{required String discovererId, String? description}) → Future< UpdateDiscovererResponse> - Updates the discoverer
-
updateRegistry(
{required String registryName, String? description}) → Future< UpdateRegistryResponse> - Updates a registry.
-
updateSchema(
{required String registryName, required String schemaName, String? clientTokenId, String? content, String? description, Type? type}) → Future< UpdateSchemaResponse> - Updates the schema definition
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited