# Module `netapp_ontap.resources.snaplock_file_fingerprint`

Copyright © 2020 NetApp Inc. All rights reserved.

Use this API to view key information about files and volumes, including the file type (regular, WORM, or WORM appendable), the volume expiration date, and so on.

## Classes

`class SnaplockFileFingerprint (*args, **kwargs)`

  Allows interaction with SnaplockFileFingerprint objects on the host

  Initialize the instance of the resource.

  Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

      MyResource(name='foo').name == 'foo'

  ## Args

  `*args`
    Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
  `**kwargs`
    each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

  ### Ancestors

  - Resource

  ### Static methods

  `def count_collection(*args, connection: HostConnection = None, **kwargs) -> int`

    Retrieves a list of all the fingerprint operations of the specified SVM and volume.

    ### Related ONTAP commands

    - `volume file fingerprint show`

    ### Example

        GET "/api/storage/snaplock/file-fingerprints/?svm.uuid=23940494-3f3a-11e9-8675-0050568e8f89&volume.uuid=36cdb58c-3f3a-11e9-8675-0050568e8f89"

    ### Learn more

    - `DOC /storage/snaplock/file-fingerprints`

    Fetch a count of all objects of this type from the host.

    This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

    ## Returns

    On success, returns an integer count of the objects of this type. On failure, returns -1.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

  `def delete_collection(*args, body: typing.Union = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Aborts an in-progress fingerprint operation. This API takes session-id as input and aborts the fingerprint operation that is associated with the specified session-id.

    ### Related ONTAP commands

    - `volume file fingerprint abort`

    ### Learn more

    - `DOC /storage/snaplock/file-fingerprints`

    Delete all objects in a collection which match the given query.

    All records on the host which match the query will be deleted.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def find(*args, connection: HostConnection = None, **kwargs) -> Resource`

    Retrieves a list of all the fingerprint operations of the specified SVM and volume.

    ### Related ONTAP commands

    - `volume file fingerprint show`

    ### Example

        GET "/api/storage/snaplock/file-fingerprints/?svm.uuid=23940494-3f3a-11e9-8675-0050568e8f89&volume.uuid=36cdb58c-3f3a-11e9-8675-0050568e8f89"

    ### Learn more

    - `DOC /storage/snaplock/file-fingerprints`

    Find an instance of an object on the host given a query.

    The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A `Resource` object containing the details of the object or None if no matches were found.

    ## Raises

    `NetAppRestError`: If the API call returned more than 1 matching resource.

  `def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> typing.Iterable`

    Retrieves a list of all the fingerprint operations of the specified SVM and volume.

    ### Related ONTAP commands

    - `volume file fingerprint show`

    ### Example

        GET "/api/storage/snaplock/file-fingerprints/?svm.uuid=23940494-3f3a-11e9-8675-0050568e8f89&volume.uuid=36cdb58c-3f3a-11e9-8675-0050568e8f89"

    ### Learn more

    - `DOC /storage/snaplock/file-fingerprints`

    Fetch a list of all objects of this type from the host.

    This is a lazy fetch, making API calls only as necessary when the result of this call is iterated over. For instance, if max_records is set to 5, then iterating over the collection causes an API call to be sent to the server once for every 5 records. If the client stops iterating before getting to the 6th record, then no additional API calls are made.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `max_records`
      The maximum number of records to return per call
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A list of `Resource` objects

    ## Raises

    `NetAppRestError`: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

  ### Methods

  `def delete(self, body: typing.Union = None, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse`

    Aborts an in-progress fingerprint operation. This API takes session-id as input and aborts the fingerprint operation that is associated with the specified session-id.

    ### Related ONTAP commands

    - `volume file fingerprint abort`

    ### Learn more

    - `DOC /storage/snaplock/file-fingerprints`

    Send a deletion request to the host for this object.

    ## Args

    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def get(self, **kwargs) -> NetAppResponse`

    Retrieves the file fingerprint information for a specific session ID.

    ### Related ONTAP commands

    - `volume file fingerprint dump`

    ### Learn more

    - `DOC /storage/snaplock/file-fingerprints`

    Fetch the details of the object from the host.

    Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse`

    Creates a fingerprint computation session on the file and returns a session-id. This session-id is a unique identifier that you can use to retrieve the progress of an ongoing fingerprint operation. When the operation is complete, you can use the session-id to retrieve the complete fingerprint output for the file .

    ### Required properties

    - `svm.uuid` or `svm.name` - Name or UUID of the SVM.
    - `volume.name` or `volume.uuid` - Name or UUID of the volume.
    - `path` - Path of the file.

    ### Default property values

    If not specified in POST, the follow default property values are assigned: * `algorithm` - md5

    ### Related ONTAP commands

    - `volume file fingerprint start`

    ### Example

        POST "/api/storage/snaplock/file-fingerprints" '{"svm":{"uuid":"23940494-3f3a-11e9-8675-0050568e8f89"},"volume": {"uuid":"26cdb58c-3f3a-11e9-8675-0050568e8f89"},"path":"/vol/a1.txt","algorithm":"md5"}'

    ### Learn more

    - `DOC /storage/snaplock/file-fingerprints`

    Send this object to the host as a creation request.

    ## Args

    `hydrate`
      If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `**kwargs`
      Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `async def snaplock_file_fingerprint_create(links: dict = None, algorithm: str = None, data_fingerprint: str = None, file_size: netapp_ontap.resource.Size = None, file_type: str = None, id: netapp_ontap.resource.Size = None, metadata_fingerprint: str = None, path: str = None, scope: str = None, state: str = None, svm: dict = None, volume: dict = None) -> netapp_ontap.resource_table.ResourceTable`

    Create an instance of a SnaplockFileFingerprint resource

    ## Args

    `links`
    `algorithm`
      The digest algorithm which is used for the fingerprint computation
    `data_fingerprint`
      The digest value of data of the file. The fingerprint is base64 encoded. This field is not included if the scope is metadata-only.
    `file_size`
      The size of the file in bytes.
    `file_type`
      The type of the file.
    `id`
      A unique identifier for the fingerprint operation
    `metadata_fingerprint`
      The digest value of metadata of the file. The metadata fingerprint is calculated for file size, file ctime, file mtime, file crtime, file retention time, file uid, file gid, and file type. The fingerprint is base64 encoded. This field is not included if the scope is data-only.
    `path`
      Specifies the path on which file fingerprint operation is running or has completed. Specifies the path relative to the output volume root, of the form "/path". The path can be path to a file or a directory.
    `scope`
      The scope of the file which is used for the fingerprint computation
    `state`
      Specifies the status of fingerprint operation.
    `svm`

    volume:

  `async def snaplock_file_fingerprint_delete(algorithm: str = None, data_fingerprint: str = None, file_size: netapp_ontap.resource.Size = None, file_type: str = None, id: netapp_ontap.resource.Size = None, metadata_fingerprint: str = None, path: str = None, scope: str = None, state: str = None)`

    Delete an instance of a SnaplockFileFingerprint resource

    ## Args

    `algorithm`
      The digest algorithm which is used for the fingerprint computation
    `data_fingerprint`
      The digest value of data of the file. The fingerprint is base64 encoded. This field is not included if the scope is metadata-only.
    `file_size`
      The size of the file in bytes.
    `file_type`
      The type of the file.
    `id`
      A unique identifier for the fingerprint operation
    `metadata_fingerprint`
      The digest value of metadata of the file. The metadata fingerprint is calculated for file size, file ctime, file mtime, file crtime, file retention time, file uid, file gid, and file type. The fingerprint is base64 encoded. This field is not included if the scope is data-only.
    `path`
      Specifies the path on which file fingerprint operation is running or has completed. Specifies the path relative to the output volume root, of the form "/path". The path can be path to a file or a directory.
    `scope`
      The scope of the file which is used for the fingerprint computation
    `state`
      Specifies the status of fingerprint operation.
  `def snaplock_file_fingerprint_show(algorithm: cliche.arg_types.choices.Choices.define.._Choices = None, data_fingerprint: cliche.arg_types.choices.Choices.define.._Choices = None, file_size: cliche.arg_types.choices.Choices.define.._Choices = None, file_type: cliche.arg_types.choices.Choices.define.._Choices = None, id: cliche.arg_types.choices.Choices.define.._Choices = None, metadata_fingerprint: cliche.arg_types.choices.Choices.define.._Choices = None, path: cliche.arg_types.choices.Choices.define.._Choices = None, scope: cliche.arg_types.choices.Choices.define.._Choices = None, state: cliche.arg_types.choices.Choices.define.._Choices = None, fields: typing.List = None) -> netapp_ontap.resource_table.ResourceTable`

    Fetch a list of SnaplockFileFingerprint resources

    ## Args

    `algorithm`
      The digest algorithm which is used for the fingerprint computation
    `data_fingerprint`
      The digest value of data of the file. The fingerprint is base64 encoded. This field is not included if the scope is metadata-only.
    `file_size`
      The size of the file in bytes.
    `file_type`
      The type of the file.
    `id`
      A unique identifier for the fingerprint operation
    `metadata_fingerprint`
      The digest value of metadata of the file. The metadata fingerprint is calculated for file size, file ctime, file mtime, file crtime, file retention time, file uid, file gid, and file type. The fingerprint is base64 encoded. This field is not included if the scope is data-only.
    `path`
      Specifies the path on which file fingerprint operation is running or has completed. Specifies the path relative to the output volume root, of the form "/path". The path can be path to a file or a directory.
    `scope`
      The scope of the file which is used for the fingerprint computation
    `state`
      Specifies the status of fingerprint operation.

  ### Inherited members

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class SnaplockFileFingerprintSchema (*, only: typing.Union = None, exclude: typing.Union = (), many: bool = False, context: typing.Dict = None, load_only: typing.Union = (), dump_only: typing.Union = (), partial: typing.Union = False, unknown: str = None)`

  The fields of the SnaplockFileFingerprint object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `algorithm GET POST`

    The digest algorithm which is used for the fingerprint computation

    Valid choices:

    - md5
    - sha256
  `data_fingerprint GET`

    The digest value of data of the file. The fingerprint is base64 encoded. This field is not included if the scope is metadata-only.

    Example: MOFJVevxNSJm3C/4Bn5oEEYH51CrudOzZYK4r5Cfy1g=

  `file_size GET`

    The size of the file in bytes.

    Example: 1048576

  `file_type GET`

    The type of the file.

    Valid choices:

    - worm
    - worm_appendable
    - worm_active_log
    - worm_log
    - regular
  `id GET`

    A unique identifier for the fingerprint operation

    Example: 17039367

  `links GET`

    The links field of the snaplock_file_fingerprint.

  `metadata_fingerprint GET`

    The digest value of metadata of the file. The metadata fingerprint is calculated for file size, file ctime, file mtime, file crtime, file retention time, file uid, file gid, and file type. The fingerprint is base64 encoded. This field is not included if the scope is data-only.

    Example: 8iMjqJXiNcqgXT5XuRhLiEwIrJEihDmwS0hrexnjgmc=

  `path GET POST`

    Specifies the path on which file fingerprint operation is running or has completed. Specifies the path relative to the output volume root, of the form "/path". The path can be path to a file or a directory.

    Example: /homedir/dir1

  `scope GET`

    The scope of the file which is used for the fingerprint computation

    Valid choices:

    - data_and_metadata
    - data_only
    - metadata_only
  `state GET`

    Specifies the status of fingerprint operation.

    Valid choices:

    - in_progress
    - failed
    - aborting
    - completed
  `svm GET POST`

    The svm field of the snaplock_file_fingerprint.

  `volume GET POST`

    The volume field of the snaplock_file_fingerprint.