Categorygithub.com/nirmata/go-client
modulepackage
1.1.2
Repository: https://github.com/nirmata/go-client.git
Documentation: pkg.go.dev

# README

Nirmata Go Client Library

The Nirmata Go Client Library provides access to the Nirmata REST API.

# Functions

No description provided by the author
NewBatchError returns an BatchedErrors with a collection of errors as an array of errors.
NewClient creates a new Client.
NewError returns an Error object described by the code, message, and origErr.
NewGetModelID builds a new GetOptions instance with Model ID attribute and supplied fields.
NewGetOptions build a new GetOptions instance.
NewID creates a new ID.
NewObject creates a new Object.
NewQuery creates a new Query.
NewRequestFailure returns a wrapped error with additional information for request status code, and service requestID.
NewUnmarshalError returns an initialized UnmarshalError error wrapper adding the bytes that fail to unmarshal to the error.
NewURLBuilder creates a new URLBuilder.
ParseCollection parses JSON bytes to a slice of generic maps.
ParseID parses JSON bytes to an ID.
ParseIDFromMap parses a JSON data map to an ID.
ParseObject parses JSON bytes to a generic map.
ParseService converts a string to a service.
SprintError returns a string of the formatted error code.

# Constants

OutputModeDefault ...
OutputModeExport ...
OutputModeExportDetails ...
OutputModeNone ...
QueryOperatorEquals ...
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

GetOptions contains optional paramameters used when retrieving objects.
RESTRequest is used to pass HTTP Request parameters.

# Interfaces

BatchedErrors is a batch of errors which also wraps lower level errors with code, message, and original errors.
No description provided by the author
Client provides access to the Nirmata REST API.
No description provided by the author
ID identifies a model object.
Object has an unique ID, attributes, and relations.
Query provides a way to filter which objects are matched.
A RequestFailure is an interface to extract request failure information from an Error such as the request ID of the failed request returned by a service.
UnmarshalError provides the interface for the SDK failing to unmarshal data.
URLBuilder helps build a URL for the Nirmata REST API.

# Type aliases

OutputMode sets the output mode for a REST API call.
QueryOperator provides boolean and arithmetic operators for field-value pairs.
Service is an enumeration type for available services.