Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2017 StreamSets Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.streamsets.pipeline.api;
import java.util.List;
import java.util.Set;
/**
* A Record represents the unit of data Data Collector pipelines process. A record has a {@link Field}
* representing the data as well as a header for metadata information.
*
* The {@link Header} of a Record is the associated metadata, some of which is generated by the Pipeline
* runtime container.
*
* The Record API supports a field-path expressions (a simplified
* XPath like syntax) to directly access values within a
* Field value data structure:
*
*
An empty string "" refers to the root element of the Record
*
A /{NAME}NAME string refers to the '{NAME}' entry in a Map or a
* LIST_MAP
*
A [{INDEX}], with {INDEX} being a zero/positive integer, refers to the '{INDEX}' position in a
* List or a LIST_MAP
*
* A field-path expression can be used to reference a composite data structure of any depth and composition, for
* example:
*
*
/contactInfo/firstName
*
/contactInfo/lastName
*
/contactInfo/email[[0]]
*
/contactInfo/address/firstLine
*
/contactInfo/address/secondLine
*
/contactInfo/address/city
*
/contactInfo/address/state
*
/contactInfo/address/zip
*
/contactInfo/phone[[0]]/number
*
/contactInfo/phone[[0]]/type
*
/contactInfo/phone[[1]]/number
*
/contactInfo/phone[[1]]/type
*
* Using field-path expressions is possible to check for existence, access, modify and delete a Field data
* structure. The {@link #get(String)}, {@link #has(String)}, {@link #delete(String)} and {@link #getEscapedFieldPaths()}
* methods work using field- path expressions.
*
* IMPORTANT: Map key names that are not a word or use any of the following 3 special
* characters '/', '[' or ']' must be single-quoted or double-quoted, for
* example: ''foo bar'/"xyz]".
*/
public interface Record {
/**
* Metadata of the record.
*
* Some of the information in the header is populated by the Data Collector.
*/
public interface Header {
/**
* Returns the name of the stage instance that created the record.
*
* This value is automatically set by the Data Collector.
*
* @return the name of the stage instance that created the record.
*/
public String getStageCreator();
public String getSourceId();
/**
* Returns the tracking ID for the record. Primary used by the UI.
*
* This value is automatically set by the Data Collector.
*
* @return the tracking ID for the record.
*/
public String getTrackingId();
/**
* Returns the previous tracking ID for the record. Primary used by the UI.
*
* This value is automatically set by the Data Collector.
*
* @return the previous tracking ID for the record.
*/
public String getPreviousTrackingId();
/**
* Returns the stages the record went through.
*
* Teh stages instance names are separated by ':'.
*
* @return the stages the record went through.
*/
public String getStagesPath();
/**
* Return the original origin raw bytes for the record if available.
*
* @return the original origin raw bytes for the record if available, NULL otherwise.
*/
public byte[] getRaw();
/**
* Return the MIME type of the original origin raw bytes for the record if available.
*
* @return the MIME type of the original origin raw bytes for the record if available, NULL otherwise.
*/
public String getRawMimeType();
/**
* Returns the list of user defined attribute names.
*
* @return the list of user defined attribute names, if there are none it returns an empty list.
*/
public Set getAttributeNames();
/**
* Returns the value of the specified attribute.
*
* @param name attribute name.
* @return the value of the specified attribute, or NULL if the attribute does not exist.
*/
public String getAttribute(String name);
/**
* Sets an attribute.
*
* @param name attribute name.
* @param value attribute value, it cannot be NULL.
*/
public void setAttribute(String name, String value);
/**
* Deletes an attribute.
*
* @param name the attribute to delete.
*/
public void deleteAttribute(String name);
/**
* If the record has been sent to error, it returns the UUID of the data collector that sent the record to error.
*
* @return the UUID of the data collector that sent the record to error, NULL if the record has not
* been sent to error.
*/
public String getErrorDataCollectorId();
/**
* If the record has been sent to error, it returns the name of the pipeline that sent the record to error.
*
* @return the pipeline that sent the record to error, NULL if the record has not been sent to error.
*/
public String getErrorPipelineName();
/**
* If the record has been sent to error, it returns the error code.
*
* @return the error code, NULL if the record has not been sent to error.
*/
public String getErrorCode();
/**
* If the record has been sent to error, it returns the error message.
*
* @return the error message, NULL if the record has not been sent to error.
*/
public String getErrorMessage();
/**
* If the record has been sent to error, it returns the stage instance internal unique
* name that sent the message to error.
*
* @return the stage internal unique instance name that sent the message to error,
* NULL if the record has not been sent to error.
*/
public String getErrorStage();
/**
* If the record has been sent to error, it returns the stage label that sent the message
* to error. Label is user filled value that does not have to be unique and can change
* between pipeline invocations.
*
* @return the stage label that sent the message to error, NULL if the record
* has not been sent to error.
*/
public String getErrorStageLabel();
/**
* If the record has been sent to error, it returns the timestamp (UNIX Epoch time) when the record was sent to
* error.
*
* @return the timestamp (UNIX Epoch time) when the record was sent to error, NULL if the record has
* not been sent to error.
*/
public long getErrorTimestamp();
/**
* StackTrace is set when error record is caused from exceptions.
*
* @return Stack trace from exception in String format.
*/
public String getErrorStackTrace();
/**
* Job ID is set when the pipeline has an associated SCH Job ID
*
* @return Job ID in String format, NULL if Job ID does not exists.
*/
public String getErrorJobId();
/**
* Job Name is set when the pipeline has an associated SCH Job Name
*
* @return Job Name in String format, NULL if Job Name does not exists.
*/
public String getErrorJobName();
}
/**
* Returns the metadata header of the record.
*
* @return the metadata header of the record.
*/
public Header getHeader();
/**
* Returns the root data field of the record.
*
* @return the root data field of the record.
*/
public Field get();
/**
* Sets the root data field of the record.
*
* @param field the field to set.
*
* @return the old field value, or NULL if there was none.
*/
public Field set(Field field);
/**
* Returns the Field at the specified field-path.
*
* @param fieldPath field-path of the Field to retrieve.
* @return the Field at the specified field-path, or NULL if none.
*
* @see Field
*/
public Field get(String fieldPath);
/**
* Deletes the Field at the specified field-path.
*
* @param fieldPath field-path of the Field to delete.
* @return the deleted Field, or NULL if none.
*
* @see Field
*/
public Field delete(String fieldPath);
/**
* Indicates if the specified field-path has a Field or not.
*
* @param fieldPath field-path of the Field to check for existence.
* @return if the specified field-path has a Field or not.
*/
public boolean has(String fieldPath);
/**
* Returns all available field-paths in the record. This method is deprecated, and {@link #getEscapedFieldPaths()}
* should be used instead.
*
* @return all available field-paths in the record.
*/
@Deprecated
public Set getFieldPaths();
/**
* Returns all available field-paths in the record. Field-paths that contain any non-word characters are escaped by
* single quotes.
*
* @return all available field-paths in the record.
*
* @since 1.2.2.0
*/
public Set getEscapedFieldPaths();
/**
* Returns all available field-paths in the record. Field-paths that contain any non-word characters are escaped by
* single quotes.
*
* @return all available field-paths in the record. The returned List will be ordered such that list fields
* are in order (and can be deleted by iterating in the reverse order). No other ordering guarantees are made.
* Uniqueness of the list is also not guaranteed.
*/
public List getEscapedFieldPathsOrdered();
/**
* Sets a Field in the specified field-path.
*
* The field-path parent must exist.
*
* @param fieldPath the field-path to set the Field.
* @param newField the Field to set.
* @return the Field being replaced at the specified field-path, or NULL if none.
*/
public Field set(String fieldPath, Field newField);
/**
* Call given visitor for each field in this record.
*
* @param visitor Visitor that will be called for each field of the record.
*/
public void forEachField(FieldVisitor visitor) throws StageException;
}
