CIMAC-CIDC/cidc-schemas

View on GitHub
docs/docs/files.file.html

Summary

Maintainability
Test Coverage

<!DOCTYPE html>
<html>
  <head>
    <title>CIDC Schemas</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
    <style>
      .bd-placeholder-img {
        font-size: 1.125rem;
        text-anchor: middle;
        -webkit-user-select: none;
        -moz-user-select: none;
        -ms-user-select: none;
        user-select: none;
      }

      @media (min-width: 768px) {
        .bd-placeholder-img-lg {
          font-size: 3.5rem;
        }
      }
    </style>
  </head>
  <body>
    <main role="main">
      

  
    <div class="container">
        <p>
            <a href="index.html">CIDC Documentation</a>
        </p>
        <h1>
            Generic Artifact
            
        </h1>
        <p>
            <b>Description:</b>  Information about a generic file.
        </p>
    </div>

  <div class="container">
    <h3>Properties</h3>
    
    

    
        
    

    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
        
            
                
                    <tr>
    <td>
        
            <span id="data_format">
                data_format
            </span>
            
        
    </td>
    <td width=55%>
        
            Data format.
        
    </td>
    <td>
        
            &lt; const: <strong>[NOT SET]</strong> &gt;            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="upload_placeholder">
                upload_placeholder
            </span>
            
        
    </td>
    <td width=55%>
        
            A placeholder for when artifact file is being uploaded.
        
    </td>
    <td>
        
            <a href="files.core.html#upload_placeholder">
                core#upload placeholder
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="artifact_creator">
                artifact_creator
            </span>
            
        
    </td>
    <td width=55%>
        
            The name of the center that created this artifact.
        
    </td>
    <td>
        
            <a href="files.core.html#artifact_creator">
                core#artifact creator
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="uploader">
                uploader
            </span>
            
        
    </td>
    <td width=55%>
        
            The name of the person uploading the artifact.
        
    </td>
    <td>
        
            <a href="files.core.html#uploader">
                core#uploader
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="uuid">
                uuid
            </span>
            
        
    </td>
    <td width=55%>
        
            UUID of artifact.
        
    </td>
    <td>
        
            <a href="files.core.html#uuid">
                core#uuid
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="file_name">
                file_name
            </span>
            
        
    </td>
    <td width=55%>
        
            The name of the file with extension.
        
    </td>
    <td>
        
            <a href="files.core.html#file_name">
                core#file name
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="object_url">
                object_url
            </span>
            
        
    </td>
    <td width=55%>
        
            URL to artifact within Google Bucket.
        
    </td>
    <td>
        
            <a href="files.core.html#object_url">
                core#object url
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="uploaded_timestamp">
                uploaded_timestamp
            </span>
            
        
    </td>
    <td width=55%>
        
            Timestamp of when artifact was loaded into the system.
        
    </td>
    <td>
        
            <a href="files.core.html#uploaded_timestamp">
                core#uploaded timestamp
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="file_size_bytes">
                file_size_bytes
            </span>
            
        
    </td>
    <td width=55%>
        
            File size in bytes.
        
    </td>
    <td>
        
            <a href="files.core.html#file_size_bytes">
                core#file size bytes
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="md5_hash">
                md5_hash
            </span>
            
        
    </td>
    <td width=55%>
        
            MD5 Hash of artifact. Not available for composite GCS objects.
        
    </td>
    <td>
        
            <a href="files.core.html#md5_hash">
                core#md5 hash
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="crc32c_hash">
                crc32c_hash
            </span>
            
        
    </td>
    <td width=55%>
        
            CRC32c Hash of artifact.
        
    </td>
    <td>
        
            <a href="files.core.html#crc32c_hash">
                core#crc32c hash
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="visible">
                visible
            </span>
            
        
    </td>
    <td width=55%>
        
            Indicates if the artifact is visible.  If set to false, the artifact is effectively deleted.
        
    </td>
    <td>
        
            <a href="files.core.html#visible">
                core#visible
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="artifact_category">
                artifact_category
            </span>
            
        
    </td>
    <td width=55%>
        
            Artifact category.
        
    </td>
    <td>
        
            <a href="files.core.html#artifact_category">
                core#artifact category
            </a>
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="facet_group">
                facet_group
            </span>
            
        
    </td>
    <td width=55%>
        
            The internal data category for this artifact
        
    </td>
    <td>
        
            <a href="files.core.html#facet_group">
                core#facet group
            </a>
        
    </td>
</tr>
                
            
        
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
    </table>

    
  </div>


    </main>
    <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
  </body>
</html>