Module fungenerators.uuid
ballerinax/fungenerators.uuid Ballerina library
Overview
The fungenerators UUID API v1.5 connector(https://fungenerators.com/api/uuid/#apidoc) OpenAPI specification.
The fungenerators.barcode API provides capability to generate random UUIDs. it supports the following features.
- Generate random UUIDs
- Support for nil (00000000-0000-0000-0000-000000000000) uuid
- Support for RFC 4122 version 1(date-time and MAC)
- Support for RFC 4122 version 2 (date-time and MAC address, DCE security version)
- Support for RFC 4122 version 3 and 5 (namespace name based)
- Support for RFC 4122 version 4 (random)
- Support for non standard version 6 (Ordered Time UUID)
- Parse UUID strings, check for validity and get version details
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an fungenerators account
- Obtain tokens
- Follow this link to obtain tokens
Clients
fungenerators.uuid: Client
This is a generated connector from fungenerators UUID API v1.5 OpenAPI Specification. A full featured, REST based UUID generator with json/xml/jsonp result support. You can try them out right here. Click here to subscribe
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create a fungenerators account and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.fungenerators.com" - URL of the target service
generateUUID
Generate a random UUID (v4).
Parameters
- count int? (default ()) - Number of UUID's to generate (defaults to 1)
Return Type
- json|error - 200 response
parseUUID
Parse a UUID string and return its version and check whether it is valid.
Parameters
- uuidstr string - UUID String to parse
Return Type
- json|error - 200 response
generateUUIDByVersion
function generateUUIDByVersion(int 'version, int? count, string? 'type, string? text) returns json|errorGenerate a random UUID (v4).
Parameters
- 'version int - Version of the UUID spec to use. (0-5), Use '0' for nil (00000000-0000-0000-0000-000000000000) UUID.
- count int? (default ()) - Number of UUID's to generate (defaults to 1)
- 'type string? (default ()) - For v3 and v5 of UUID Spec you can supply the type (dns/url/oid/x500/nil).
- text string? (default ()) - For v3 and v5 of UUID Spec supply the text value for the type specified dns/url/oid/x500/nil. For example specify a dns/domain string if the type is "dns"
Return Type
- json|error - 200 response
Records
fungenerators.uuid: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xFungeneratorsApiSecret string - Represents API Key
X-Fungenerators-Api-Secret
fungenerators.uuid: ClientHttp1Settings
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
fungenerators.uuid: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
fungenerators.uuid: ProxyConfig
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password