# Module `netapp_ontap.resources.file_clone`

Copyright © 2020 NetApp Inc. All rights reserved.

## Classes

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

  File clone

  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

  ### Methods

  `async def file_clone_create(autodelete: bool = None, destination_path: str = None, is_backup: bool = None, overwrite_destination: bool = None, range=None, source_path: str = None, volume: dict = None) -> netapp_ontap.resource_table.ResourceTable`

    Create an instance of a FileClone resource

    ## Args

    `autodelete`
      Mark clone file for auto deletion.
    `destination_path`
      Relative path of the clone/destination file in the volume.
    `is_backup`
      Mark clone file for backup.
    `overwrite_destination`
      Destination file gets overwritten.
    `range`
      List of block ranges for sub-file cloning in the format "source-file-block-number:destination-file-block-number:block-count"
    `source_path`
      Relative path of the source file in the volume.

    volume:

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

    Creates a clone of the file.

    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

  ### Inherited members

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class FileCloneSchema (*, 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 FileClone object

  ### Ancestors

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

  ### Class variables

  `autodelete GET POST PATCH`

    Mark clone file for auto deletion.

  `destination_path GET POST PATCH`

    Relative path of the clone/destination file in the volume.

    Example: dest_file1, dir1/dest_file2

  `is_backup GET POST PATCH`

    Mark clone file for backup.

  `overwrite_destination GET POST PATCH`

    Destination file gets overwritten.

  `range GET POST PATCH`

    List of block ranges for sub-file cloning in the format "source-file-block-number:destination-file-block-number:block-count"

    Example: [36605,73210]

  `source_path GET POST PATCH`

    Relative path of the source file in the volume.

    Example: src_file1, dir1/src_file2, ./.snapshot/snap1/src_file3

  `volume GET POST PATCH`

    The volume field of the file_clone.