Module netapp_ontap.resources.data_engine_governance_file_preview_job

Copyright © 2026 NetApp Inc. All rights reserved.

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

Classes

class DataEngineGovernanceFilePreviewJob (*args, **kwargs)

File preview job.

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 post_collection (records: Iterable[ForwardRef('DataEngineGovernanceFilePreviewJob')], *args, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> Union[List[DataEngineGovernanceFilePreviewJob], NetAppResponse]

Creates a job for retrieving file information.

Required properties

• file.uuid: UUID of the entity.
• file.path: Path of the entity.
• file.format: Format of the entity.
• workspace.uuid: UUID of the workspace in which the entity is present.

---

Send this collection of objects to the host as a creation request.

Args

records

A list of Resource objects to send to the server to be created.

*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 create a bar for a particular foo, the foo.name value should be passed.

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 each object. When hydrate is set to True, poll must also be set to True.

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.

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 list of Resource objects matching the provided type which have been created by the host and returned. This is not the same list that was provided, so to continue using the object, you should save this list. If poll is set to False, then a NetAppResponse object is returned instead.

Raises

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

Methods

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

Retrieves information about a file preview job by its UUID.

---

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 or if not all of the keys required are present and config.STRICT_GET has been set to True.

def post (self, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse

Creates a job for retrieving file information.

Required properties

• file.uuid: UUID of the entity.
• file.path: Path of the entity.
• file.format: Format of the entity.
• workspace.uuid: UUID of the workspace in which the entity is present.

---

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.

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 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
  • validate_schema

class DataEngineGovernanceFilePreviewJobSchema (*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)

The fields of the DataEngineGovernanceFilePreviewJob object

Ancestors

• netapp_ontap.resource.ResourceSchema
• marshmallow.schema.Schema
• marshmallow.base.SchemaABC
• abc.ABC

Class variables

file: DataEngineGovernanceFilePreviewFileContentRequestFile GET POST PATCH

The file field of the data_engine_governance_file_preview_job.

state: str GET

Status of the job. Possible values are:

• new: Job is newly created.
• queued: Job is queued for processing.
• in_progress: Job is currently being processed.
• completed: Job completed successfully.
• warning: Job completed with warnings.
• failed: Job failed.
• timed_out: Job timed out.
• canceling: Job is being canceled.
• canceled: Job was canceled.

Valid choices:

• new
• queued
• in_progress
• completed
• warning
• failed
• timed_out
• canceling
• canceled

uuid: str GET POST PATCH

Unique identifier of the file preview job.

Example: 4ea7a442-86d1-11e0-ae1c-123478563412

workspace: DataEngineGovernanceFilePreviewFileContentRequestWorkspace GET POST PATCH

The workspace field of the data_engine_governance_file_preview_job.