self1/gwPolicyConnector

1.0.0

Package Overview

This package provides a simple function to print "Hello, World!" to the command line. Additionally, you can provide a name to the function to print a personalized greeting.

Usage

Importing the Package


import ballerina/io;
import self1/gwPolicyConnector;

Using the hello Function


public function main() {
    string greeting = exavalu1:hello("Ballerina");
    io:println(exavalu1:hello("Ballerina")); // Output: Hello, Ballerina
}

You can call the hello function without any arguments to get the default greeting:


public function main() {
    string greeting = exavalu1:hello();
    io:println(greeting); // Output: Hello, World!
}

Functions

hello

function hello(string? name) returns string

Returns the string Hello with the input string name.

Parameters

name string? - name as a string or nil

Return Type

string - "Hello, " with the input string name

Clients

gwPolicyConnector: Client

Isolated

Mock Policy API for retrieving policy details

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig {} - The configurations to be used when initializing the connector

serviceUrl string "https://6b3ef17e-2216-4137-876a-29b06885dafb.mock.pstmn.io" - URL of the target service

get policy/v1/policies/[string policyId]

Isolated FunctionResource Function

function get policy/v1/policies/[string policyId](map<string|string[]> headers) returns PolicyResponse|error

Get Policy Details

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PolicyResponse|error - Policy retrieved successfully

get policy/v1/search/policies

Isolated FunctionResource Function

function get policy/v1/search/policies(map<string|string[]> headers) returns PolicySearchResult|error

Search for policies that match the specified criteria

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PolicySearchResult|error - Return a list of policies that match the search criteria

post job/v1/submissions

Isolated FunctionResource Function

function post job/v1/submissions(SubmissionRequest payload, map<string|string[]> headers) returns SubmissionResponse|error

Create a new submission job

Parameters

payload SubmissionRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SubmissionResponse|error - Submission created successfully

get rest/job/v1/jobs/[string jobId]

Isolated FunctionResource Function

function get rest/job/v1/jobs/[string jobId](map<string|string[]> headers) returns JobResponse|error

Get Job Details

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

JobResponse|error - Job retrieved successfully

post job/v1/jobs/[string jobId]/quote

Isolated FunctionResource Function

function post job/v1/jobs/[string jobId]/quote(JobActionRequest payload, map<string|string[]> headers) returns JobActionResponse|error

Create Quote

Parameters

payload JobActionRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

JobActionResponse|error - Quote generated

post job/v1/jobs/[string jobId]/make-draft

Isolated FunctionResource Function

function post job/v1/jobs/[string jobId]/make\-draft(JobActionRequest payload, map<string|string[]> headers) returns JobActionResponse|error

Make Draft

Parameters

payload JobActionRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

JobActionResponse|error - Job moved to draft

post job/v1/jobs/[string jobId]/bind-and-issue

Isolated FunctionResource Function

function post job/v1/jobs/[string jobId]/bind\-and\-issue(JobActionRequest payload, map<string|string[]> headers) returns JobActionResponse|error

Bind and Issue Policy

Parameters

payload JobActionRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

JobActionResponse|error - Policy bound and issued

post job/v1/jobs/[string jobId]/bind-only

Isolated FunctionResource Function

function post job/v1/jobs/[string jobId]/bind\-only(JobActionRequest payload, map<string|string[]> headers) returns JobActionResponse|error

Bind Policy

Parameters

payload JobActionRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

JobActionResponse|error - Policy bound

post job/v1/jobs/[string jobId]/issue

Isolated FunctionResource Function

function post job/v1/jobs/[string jobId]/issue(JobActionRequest payload, map<string|string[]> headers) returns JobActionResponse|error

Issue Policy

Parameters

payload JobActionRequest -

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

JobActionResponse|error - Policy issued

Records

gwPolicyConnector: ConnectionConfig

Closed record

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(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

followRedirects? FollowRedirects - Configurations associated with Redirection

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache CacheConfig(default {}) - 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

cookieConfig? CookieConfig - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.