# Module `netapp_ontap.resources.object_store_endpoint_info`

Copyright © 2022 NetApp Inc. All rights reserved.

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

## Overview

When a SnapMirror relationship created by a SnapMirror POST API with an object store destination endpoint is populated, a UUID is created to reference the data that is stored in the object store for this endpoint. This API allows these endpoints, using the object store's UUID and endpoint UUID to identify the endpoint to be manipulated. If a SnapMirror relationship with an object store endpoint path, in the form of :/objstore/, is deleted, that same object store endpoint path can be reused in a subsequent SnapMirror relationship. This means that an object store endpoint path can be associated with different relationship UUIDs and different object store UUIDs. The user is expected to maintain a mapping of object store endpoint paths and UUIDs manually, so as to be able to provide the correct UUID to this API. An object store is created using a /cloud/target API. Object store entities are referred to here as 'object store', 'object-store' or 'object_store' below, depending on context.

## Classes

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

  Allows interaction with ObjectStoreEndpointInfo 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 delete_collection(*args, records: Iterable[_ForwardRef('ObjectStoreEndpointInfo')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    This API deletes all the data of a specific endpoint within an object store that was populated by SnapMirror. The object store UUID, together with the endpoint's UUID will be used to specify the data to be processed by this API.

    ### Related ONTAP commands

    - `snapmirror object-store endpoint delete`

    ### Examples

    DELETE "/api/snapmirror/object-stores/cd9563a0-2e59-11ea-a778-00505682bd8f/endpoints/af86c94c-bcb2-4b4e-b8cc-c294793a310a/"

    ### Learn more

    - `DOC /snapmirror/object-stores/{object_store.uuid}/endpoints/{uuid}`

    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.
    `records`
      Can be provided in place of a query. If so, this list of objects will be deleted from the host.
    `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.
    `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 deleted.

    ## Returns

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

    ## Raises

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

  ### Methods

  `def delete(self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse`

    This API deletes all the data of a specific endpoint within an object store that was populated by SnapMirror. The object store UUID, together with the endpoint's UUID will be used to specify the data to be processed by this API.

    ### Related ONTAP commands

    - `snapmirror object-store endpoint delete`

    ### Examples

    DELETE "/api/snapmirror/object-stores/cd9563a0-2e59-11ea-a778-00505682bd8f/endpoints/af86c94c-bcb2-4b4e-b8cc-c294793a310a/"

    ### Learn more

    - `DOC /snapmirror/object-stores/{object_store.uuid}/endpoints/{uuid}`

    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 information for the specified object store, endpoint.

    ### Related ONTAP commands

    - `snapmirror object-store endpoint show`

    ### Example

    GET "/api/snapmirror/object-stores/cd9563a0-2e59-11ea-a778-00505682bd8f/endpoints/af86c94c-bcb2-4b4e-b8cc-c294793a310a/"

    ### Learn more

    - `DOC /snapmirror/object-stores/{object_store.uuid}/endpoints/{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

  ### Inherited members

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

  ### Ancestors

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

  ### Class variables

  `archived_objects: bool GET`

    Indicates whether or not the endpoint has objects in the archival storage.

  `destination: ObjectStoreEndpointInfoDestination GET POST PATCH`

    The destination field of the object_store_endpoint_info.

  `links: SelfLink GET`

    The links field of the object_store_endpoint_info.

  `object_store: ObjectStoreEndpointInfoObjectStore GET POST PATCH`

    The object_store field of the object_store_endpoint_info.

  `source: ObjectStoreEndpointInfoSource GET POST PATCH`

    The source field of the object_store_endpoint_info.

  `uuid: str GET POST PATCH`

    Destination endpoint UUID.

    Example: 21c3abec-ee22-11ea-8048-00505682f04b