com.trend.cloudone.amaas.AMaasErrorCode Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of file-security-java-sdk Show documentation
Show all versions of file-security-java-sdk Show documentation
Trend Vision One File Security Java SDK
package com.trend.cloudone.amaas;
/**
* Enum type defines all the AMaaS error code and message templates.
*/
public enum AMaasErrorCode {
/**
* Scan file cannot be found.
*/
MSG_ID_ERR_FILE_NOT_FOUND("MSG_ID_ERR_FILE_NOT_FOUND", "Failed to open file. No such file or directory %s."),
/**
* Have no permission to open the scan file.
*/
MSG_ID_ERR_FILE_NO_PERMISSION("MSG_ID_ERR_FILE_NO_PERMISSION", "Failed to open file. Permission denied to open %s."),
/**
* Incorrect region is given.
*/
MSG_ID_ERR_INVALID_REGION("MSG_ID_ERR_INVALID_REGION", "%s is not a supported region, region value should be one of %s"),
/**
* Cloudone credetial is not given.
*/
MSG_ID_ERR_MISSING_AUTH("MSG_ID_ERR_MISSING_AUTH", "Must provide an API key to use the client."),
/**
* An GRPC error was reported.
*/
MSG_ID_GRPC_ERROR("MSG_ID_GRPC_ERROR", "Received gRPC status code: %d, msg: %s."),
/**
* Authentication failed using the given Cloudone credential.
*/
MSG_ID_ERR_KEY_AUTH_FAILED("MSG_ID_ERR_KEY_AUTH_FAILED", "Authorization key cannot be authenticated."),
/**
* Java SDK client received an unexpected interrupt.
*/
MSG_ID_ERR_UNEXPECTED_INTERRUPT("MSG_ID_ERR_UNEXPECTED_INTERRUPT", "Unexpected interrupt encountered."),
/**
* Java SDK client received an unexpected interrupt.
*/
MSG_ID_ERR_MAX_NUMBER_OF_TAGS("MSG_ID_ERR_MAX_NUMBER_OF_TAGS", "Exceeded maximum number of tags: %d"),
/**
* Java SDK client received an unexpected interrupt.
*/
MSG_ID_ERR_LENGTH_OF_TAG("MSG_ID_ERR_LENGTH_OF_TAG", "Tag length must be between 1 and %d: %s."),
/**
* Java SDK client has an unexpected interrupt.
*/
MSG_ID_ERR_UNEXPECTED("MSG_ID_ERR_UNEXPECTED", "Unexpected error encountered.");
private final String errorCode;
private final String message;
/**
* The constructor for an AMass error type.
* @param errorCode error code to be used
* @param message template to be used.
*/
AMaasErrorCode(final String errorCode, final String message) {
this.errorCode = errorCode;
this.message = message;
}
/**
* The method returns the code of the error enum.
* @return return the error code.
*/
public String getErrorCode() {
return this.errorCode;
}
/**
* This method returns a message for the error enum with no parameters.
* @return return the message associated with the error enum.
*/
public String getMessage() {
return this.message;
}
/**
* This method returns a message prepared using the template with the given parameters.
* @param params objects to be used to format the template.
* @return message prepared from the templates using the parameters.
*/
public String getMessage(final Object... params) {
return String.format(this.message, params);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy