package
0.14.15
Repository: https://github.com/cyverse/go-irodsclient.git
Documentation: pkg.go.dev

# Functions

MakeIRODSMessageHeader makes a message header.
NewIRODSMessageAddMetadataRequest creates a IRODSMessageModMetaRequest message for adding a metadata AVU on some item.
NewIRODSMessageAdminRequest creates a new IRODSMessageAdminRequest.
NewIRODSMessageAuthPluginRequest creates a IRODSMessageAuthPluginRequest.
NewIRODSMessageAuthPluginResponse creates a IRODSMessageAuthPluginResponse.
NewIRODSMessageAuthRequest creates a IRODSMessageAuthRequest message.
NewIRODSMessageAuthResponse creates a IRODSMessageAuthResponse message.
NewIRODSMessageByteData creates a IRODSMessageByteData message.
NewIRODSMessageChecksumRequest creates a IRODSMessageChecksumRequest message.
NewIRODSMessageCloseDataObjectReplicaRequest creates a IRODSMessageCloseDataObjectReplicaRequest message.
NewIRODSMessageCloseDataObjectRequest creates a IRODSMessageCloseDataObjectRequest message.
NewIRODSMessageCopyDataObjectRequest creates a IRODSMessageCopyDataObjectRequest message.
NewIRODSMessageCreateDataObjectRequest creates a IRODSMessageCreateDataObjectRequest message.
NewIRODSMessageCreateobjRequestWithKeyVals creates a IRODSMessageCreateobjRequest message with given keyvals.
NewIRODSMessageCSNegotiation creates a IRODSMessageCSNegotiation message.
NewIRODSMessageDisconnect creates a IRODSMessageAuthRequest message.
NewIRODSMessageEndTransactionRequest creates a IRODSMessageEndTransactionRequest message.
No description provided by the author
NewIRODSMessageExtractStructFileRequest creates a IRODSMessageExtractstructfileRequest message.
NewIRODSMessageGetDataObjectCompleteRequest creates a IRODSMessageGetDataObjectCompleteRequest message.
NewIRODSMessageGetDataObjectRequest creates a IRODSMessageGetDataObjectRequest message.
NewIRODSMessageGetDescriptorInfoRequest creates a IRODSMessageDescriptorInfoRequest message.
NewIRODSMessageGetFileStatRequest creates a IRODSMessageGetFileStatRequest message.
NewIRODSMessageGetProcessstatRequest creates a IRODSMessageGetProcessstatRequest message.
NewIRODSMessageHost creates a IRODSMessageHost message.
NewIRODSMessageIIKeyVal creates a new IRODSMessageIIKeyVal.
NewIRODSMessageInt creates a IRODSMessageInt message.
NewIRODSMessageISKeyVal creates a new IRODSMessageISKeyVal.
NewIRODSMessageLockDataObjectRequest creates a IRODSMessageLockDataObjectRequest message.
NewIRODSMessageMakeCollectionRequest creates a IRODSMessageMakeCollectionRequest message.
NewIRODSMessageModifyAccessRequest creates a IRODSMessageModAccessRequest message for altering the access control list of a object or collection.
NewIRODSMessageModifyCollectionRequest creates a IRODSMessageModifyCollectionRequest message.
NewIRODSMessageMoveCollectionRequest creates a IRODSMessageMvcolRequest message.
NewIRODSMessageMoveDataObjectRequest creates a IRODSMessageMoveDataObjectRequest message.
NewIRODSMessageOpenDataObjectRequest creates a IRODSMessageOpenDataObjectRequest message.
NewIRODSMessageOpenobjRequestForPutParallel ...
NewIRODSMessageOpenobjRequestWithOperation ...
NewIRODSMessageOpenobjRequestWithReplicaToken creates a IRODSMessageOpenobjRequest message.
NewIRODSMessageOperationCompleteRequest creates a IRODSMessageOperationCompleteRequest message.
NewIRODSMessagePamAuthRequest creates a IRODSMessagePamAuthRequest message.
NewIRODSMessagePutDataObjectRequest creates a IRODSMessagePutDataObjectRequest message.
NewIRODSMessageQueryRequest creates a IRODSMessageQueryRequest message.
NewIRODSMessageQuerySpecificRequest creates a IRODSMessageQuerySpecificRequest message.
NewIRODSMessageReadDataObjectRequest creates a IRODSMessageReadDataObjectRequest message.
NewIRODSMessageReadLockDataObjectRequest creates a IRODSMessageLockDataObjectRequest message.
NewIRODSMessageRemoveCollectionRequest creates a IRODSMessageRemoveCollectionRequest message.
NewIRODSMessageRemoveDataObjectRequest creates a IRODSMessageRemoveDataObjectRequest message.
NewIRODSMessageRemoveMetadataByIDRequest creates a IRODSMessageModMetaRequest message for removing a metadata AVU by its AVUID.
NewIRODSMessageRemoveMetadataRequest creates a IRODSMessageModMetaRequest message for removing a metadata AVU.
NewIRODSMessageRemoveMetadataWildcardRequest creates a IRODSMessageModMetaRequest message for removing a metadata AVU by itemName and attributeValue.
NewIRODSMessageReplaceMetadataRequest creates a IRODSMessageModMetaRequest message for replacing a metadata AVU.
NewIRODSMessageReplicateDataObjectRequest creates a IRODSMessageReplicateDataObjectRequest message.
NewIRODSMessageResourceServerAuth creates a IRODSMessageResourceServerAuth message.
NewIRODSMessageResourceServerTransferEncryptionHeader creates IRODSMessageResourceServerTransferEncryptionHeader.
NewIRODSMessageSeekDataObjectRequest creates a IRODSMessageSeekDataObjectRequest message.
NewIRODSMessageSetMetadataRequest creates a IRODSMessageModMetaRequest message for changing the first metadata AVU on the given item with a matching attribute name to the given value an units.
NewIRODSMessageSSKeyVal creates a new IRODSMessageSSKeyVal.
NewIRODSMessageSSLSettings creates a IRODSMessageSSLSettings message.
NewIRODSMessageSSLSharedSecret creates a IRODSMessageSSLSharedSecret message.
NewIRODSMessageStartupPack creates a IRODSMessageStartupPack message.
NewIRODSMessageTicketAdminRequest creates a new IRODSMessageTicketAdminRequest.
NewIRODSMessageTrimDataObjectRequest creates a IRODSMessageTrimDataObjectRequest message.
NewIRODSMessageTruncateDataObjectRequest creates a IRODSMessageTruncateDataObjectRequest message.
NewIRODSMessageUnlockDataObjectRequest creates a IRODSMessageUnlockDataObjectRequest message.
NewIRODSMessageUserAdminRequest creates a new IRODSMessageUserAdminRequest.
NewIRODSMessageWriteDataObjectRequest creates a IRODSMessageWriteDataObjectRequest message.
NewIRODSMessageWriteLockDataObjectRequest creates a IRODSMessageLockDataObjectRequest message.

# Constants

unknown.
RequestNegotiationOptionString is an option string for requesting server negotiation.
RODS_MESSAGE_API_REPLY_TYPE is a type for api response.
RODS_MESSAGE_API_REQ_TYPE is a type for api request.
RODS_MESSAGE_CONNECT_TYPE is a message type for establishing a new connection.
negotiation constants.
RODS_MESSAGE_DISCONNECT_TYPE is a message type for disconnecting.
RODS_MESSAGE_SSL_SHARED_SECRET_TYPE is a message type for shared secret used in SSL connection establishment.
RODS_MESSAGE_VERSION_TYPE is a message type for version.

# Structs

No description provided by the author
IRODSMessage defines a message.
IRODSMessageAdminRequest stores alter metadata request.
IRODSMessageAdminResponse stores alter metadata response.
IRODSMessageAuthChallengeResponse stores auth challenge.
IRODSMessageAuthPluginRequest stores auth plugin request.
IRODSMessageAuthPluginResponse stores auth plugin info.
IRODSMessageAuthRequest stores authentication request.
IRODSMessageAuthResponse stores auth response.
IRODSMessageAuthResult stores authentication result.
IRODSMessageBinBytesBuf stores bytes buffer.
IRODSMessageBody defines a message body.
IRODSMessageByteData stores byte data.
IRODSMessageChecksumResponse stores data object checksum response.
IRODSMessageCloseDataObjectReplicaRequest stores data object replica close request Uses JSON, not XML Supported v4.2.9 or above.
IRODSMessageCloseDataObjectReplicaResponse stores data object replica close response.
IRODSMessageCloseDataObjectResponse stores data object close response.
IRODSMessageCopyDataObjectRequest stores data object copy request.
IRODSMessageCopyDataObjectResponse stores data object copy response.
IRODSMessageCreateDataObjectResponse stores data object creation response.
IRODSMessageCSNegotiation stores client-server negotiation message.
IRODSMessageDataObjectRequest ...
IRODSMessageDisconnect stores disconnect request.
IRODSMessageEndTransactionRequest stores collection creation request.
IRODSMessageEndTransactionResponse stores end transaction response.
No description provided by the author
IRODSMessageExtractStructFileRequest stores struct file extraction request.
IRODSMessageExtractStructFileResponse stores struct file extraction response.
IRODSMessageGetDataObjectCompleteResponse stores get data object complete response.
IRODSMessageGetDataObjectStatResponse stores file stat response.
IRODSMessageGetDescriptorInfoRequest stores data object descriptor info.
IRODSMessageGetDescriptorInfoResponse stores data object descriptor info.
IRODSMessageGetFileStatRequest stores file stat request.
IRODSMessageGetFileStatResponse stores data object read response.
IRODSMessageGetProcessstatRequest stores process stat request.
IRODSMessageHeader defines a message header.
IRODSMessageHost stores startup message.
IRODSMessageIIKeyVal ..
IRODSMessageInt stores int message.
IRODSMessageISKeyVal ..
IRODSMessageLockDataObjectResponse stores data object lock response.
IRODSMessageMakeCollectionRequest stores collection creation request.
IRODSMessageMakeCollectionResponse stores collection creation response.
IRODSMessageModifyAccessRequest stores alter access control request.
IRODSMessageModifyAccessResponse stores alter metadata response.
IRODSMessageModifyCollectionResponse stores alter metadata response.
IRODSMessageModifyMetadataRequest stores alter metadata request.
IRODSMessageModifyMetadataResponse stores alter metadata response.
IRODSMessageMoveCollectionRequest stores collection move request.
IRODSMessageMoveCollectionResponse stores collection move response.
IRODSMessageMoveDataObjectRequest stores data object move request.
IRODSMessageMoveDataObjectResponse stores data object move response.
IRODSMessageOpenDataObjectResponse stores data object open response.
IRODSMessageOpenedDataObjectRequest ...
IRODSMessageOperationCompleteResponse stores operation complete response.
IRODSMessagePamAuthRequest stores auth response.
IRODSMessagePamAuthResponse stores auth challenge.
IRODSMessagePortalResponse stores portal response.
No description provided by the author
IRODSMessageQueryRequest stores query.
IRODSMessageQueryResponse stores query result.
IRODSMessageQuerySpecificRequest stores specific query request.
IRODSMessageRawString ...
IRODSMessageReadDataObjectResponse stores data object read response.
IRODSMessageRemoveCollectionRequest stores collection deletion request.
IRODSMessageRemoveCollectionResponse stores collection deletion response.
IRODSMessageRemoveDataObjectResponse stores data object deletion response.
IRODSMessageReplicateDataObjectResponse stores data object replication response.
IRODSMessageResourceServerAuth stores resource server authentication message.
IRODSMessageResourceServerTransferEncryptionHeader stores resource server transfer encryption header message.
IRODSMessageResourceServerTransferHeader stores resource server transfer header message.
IRODSMessageSeekDataObjectResponse stores data object seek response.
No description provided by the author
IRODSMessageSQLResult ..
IRODSMessageSSKeyVal ..
IRODSMessageSSLSettings stores ssl settings.
IRODSMessageSSLSharedSecret stores shared secret data.
IRODSMessageStartupPack stores startup message.
IRODSMessageTicketAdminRequest stores ticket admin request.
IRODSMessageTicketAdminResponse stores ticket admin response.
IRODSMessageTrimDataObjectResponse stores data object trim response.
IRODSMessageTruncateDataObjectResponse stores data object truncation response.
IRODSMessageUnlockDataObjectResponse stores data object unlock response.
IRODSMessageUserAdminRequest stores alter metadata request.
IRODSMessageUserAdminResponse stores alter metadata response.
IRODSMessageVersion stores version message.
IRODSMessageWriteDataObjectRequest stores data object read request type IRODSMessageWriteDataObjectRequest IRODSMessageOpenedDataObjectRequest.
IRODSMessageWriteDataObjectResponse stores data object write response.
No description provided by the author

# Interfaces

IRODSMessageSerializationInterface is an interface for serializaing/deserializing of message.

# Type aliases

IRODSMessageChecksumRequest stores data object checksum request.
IRODSMessageCloseDataObjectRequest stores data object close request.
IRODSMessageCreateDataObjectRequest stores data object creation request.
IRODSMessageGetDataObjectCompleteRequest stores get data object complete request.
IRODSMessageGetDataObjectRequest stores file get request.
IRODSMessageGetDataObjectResponse stores file get response.
IRODSMessageGetDataObjectStatRequest stores file stat request.
IRODSMessageLockDataObjectRequest stores data object lock request.
IRODSMessageModifyCollectionRequest stores mod coll request.
IRODSMessageOpenDataObjectRequest stores data object open request.
IRODSMessageOperationCompleteRequest stores operation complete request.
IRODSMessagePutDataObjectRequest stores file put request.
IRODSMessagePutDataObjectResponse stores file put response.
No description provided by the author
IRODSMessageReadDataObjectRequest stores data object read request.
IRODSMessageRemoveDataObjectRequest stores data object deletion request.
IRODSMessageReplicateDataObjectRequest stores data object replication request.
IRODSMessageSeekDataObjectRequest stores data object seek request.
IRODSMessageTrimDataObjectRequest stores data object replication request.
IRODSMessageTruncateDataObjectRequest stores data object truncation request.
IRODSMessageUnlockDataObjectRequest stores data object unlock request.
MessageType is a message type.