# Module `netapp_ontap.resources.xc_application`

Copyright © 2022 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

## Classes

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

  application clone for cluster peer.

  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`

    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 find(*args, connection: HostConnection = None, **kwargs) -> Resource`

    Cross cluster GET applications

    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) -> Iterable[Resource]`

    Cross cluster GET applications

    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.

  ### Inherited members

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

  The fields of the XcApplication object

  ### Ancestors

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

  ### Class variables

  `creation_timestamp: str GET`

    The time when the application was created.

  `delete_data: bool POST`

    Should application storage elements be deleted? An application is considered to use storage elements from a shared storage pool. Possible values are 'true' and 'false'. If the value is 'true', the application will be deleted in its entirety. If the value is 'false', the storage elements will be disassociated from the application and preserved. The application will then be deleted.

  `generation: Size GET`

    The generation number of the application. This indicates which features are supported on the application. For example, generation 1 applications do not support Snapshot copies. Support for Snapshot copies was added at generation 2. Any future generation numbers and their feature set will be documented.

  `links: ApplicationLinks GET POST PATCH`

    The links field of the xc_application.

  `maxdata_on_san: MaxdataOnSan GET POST PATCH`

    The maxdata_on_san field of the xc_application.

  `mongo_db_on_san: MongoDbOnSan GET POST PATCH`

    The mongo_db_on_san field of the xc_application.

  `name: str GET POST`

    Application Name. This field is user supplied when the application is created.

  `nas: Nas GET POST PATCH`

    The nas field of the xc_application.

  `nvme: ZappNvme GET POST PATCH`

    The nvme field of the xc_application.

  `oracle_on_nfs: OracleOnNfs GET POST PATCH`

    The oracle_on_nfs field of the xc_application.

  `oracle_on_san: OracleOnSan GET POST PATCH`

    The oracle_on_san field of the xc_application.

  `oracle_rac_on_nfs: OracleRacOnNfs GET POST PATCH`

    The oracle_rac_on_nfs field of the xc_application.

  `oracle_rac_on_san: OracleRacOnSan GET POST PATCH`

    The oracle_rac_on_san field of the xc_application.

  `protection_granularity: str GET`

    Protection granularity determines the scope of Snapshot copy operations for the application. Possible values are "application" and "component". If the value is "application", Snapshot copy operations are performed on the entire application. If the value is "component", Snapshot copy operations are performed separately on the application components.

    Valid choices:

    - application
    - component
  `rpo: ApplicationRpo GET POST PATCH`

    The rpo field of the xc_application.

  `s3_bucket: ZappS3Bucket GET POST PATCH`

    The s3_bucket field of the xc_application.

  `san: San GET POST PATCH`

    The san field of the xc_application.

  `smart_container: bool GET POST`

    Identifies if this is a smart container or not.

  `sql_on_san: SqlOnSan GET POST PATCH`

    The sql_on_san field of the xc_application.

  `sql_on_smb: SqlOnSmb GET POST PATCH`

    The sql_on_smb field of the xc_application.

  `state: str GET`

    The state of the application. For full functionality, applications must be in the online state. Other states indicate that the application is in a transient state and not all operations are supported.

    Valid choices:

    - creating
    - deleting
    - modifying
    - online
    - restoring
  `statistics: ApplicationStatistics GET POST PATCH`

    The statistics field of the xc_application.

  `svm: ApplicationSvm GET POST`

    The svm field of the xc_application.

  `template: ApplicationTemplate1 GET POST PATCH`

    The template field of the xc_application.

  `uuid: str GET`

    Application UUID. This field is generated when the application is created.

  `vdi_on_nas: VdiOnNas GET POST PATCH`

    The vdi_on_nas field of the xc_application.

  `vdi_on_san: VdiOnSan GET POST PATCH`

    The vdi_on_san field of the xc_application.

  `vsi_on_nas: VsiOnNas GET POST PATCH`

    The vsi_on_nas field of the xc_application.

  `vsi_on_san: VsiOnSan GET POST PATCH`

    The vsi_on_san field of the xc_application.