Skip to main content
Ctrl+K
PRISM-SDK

PRISM-SDK

Site Navigation

  • Getting Started
  • Configuration
  • SDK Reference
  • Examples
Ctrl+K

Site Navigation

  • Getting Started
  • Configuration
  • SDK Reference
  • Examples
Ctrl+K

Section Navigation

  • ntnx_prism_py_client package
    • api package
      • batches_api
      • categories_api
      • domain_manager_api
      • domain_manager_backups_api
      • tasks_api
    • models package
      • clustermgmt package
        • v4 package
          • config package
            • BuildInfo
            • ClusterConfig
            • ClusterNetwork
      • common package
        • v1 package
          • config package
            • BasicAuth
            • FQDN
            • Flag
            • IPAddress
            • IPAddressOrFQDN
            • IPv4Address
            • IPv6Address
            • IpRange
            • KVPair
            • MapOfStringWrapper
            • Message
            • MessageSeverity
            • TenantAwareModel
          • response package
            • ApiLink
            • ApiResponseMetadata
            • ExternalizableAbstractModel
      • prism package
        • v4 package
          • config package
            • AssociationDetail
            • AssociationDetailOld
            • AssociationDetailOldProjection
            • AssociationDetailProjection
            • AssociationSummary
            • AssociationSummaryProjection
            • BaseNetwork
            • BootstrapConfig
            • CancelTaskApiResponse
            • Category
            • CategoryAssociationSummaryOld
            • CategoryAssociationSummaryOldProjection
            • CategoryOld
            • CategoryOldProjection
            • CategoryProjection
            • CategorySummaryOld
            • CategorySummaryOldProjection
            • CategoryType
            • CreateCategoryApiResponse
            • CreateDomainManagerApiResponse
            • DeleteCategoryApiResponse
            • DomainManager
            • DomainManagerClusterConfig
            • DomainManagerNetwork
            • DomainManagerResourceConfig
            • EntityReference
            • EnvironmentInfo
            • EnvironmentType
            • ExternalNetwork
            • GetCategoryApiResponse
            • GetDomainManagerApiResponse
            • GetTaskApiResponse
            • ListCategoriesApiResponse
            • ListDomainManagerApiResponse
            • ListTasksApiResponse
            • OwnerReference
            • ProviderType
            • ProvisioningType
            • Reference
            • ResourceGroup
            • ResourceType
            • Size
            • Task
            • TaskReference
            • TaskReferenceInternal
            • TaskStatus
            • TaskStep
            • UpdateCategoryApiResponse
          • error package
            • AppMessage
            • ErrorResponse
            • SchemaValidationError
            • SchemaValidationErrorMessage
          • management package
            • AOSRemoteClusterSpec
            • AWSS3Config
            • AccessKeyCredentials
            • AddRootCertificateApiResponse
            • BackupPolicy
            • BackupTarget
            • ClusterLocation
            • ClusterReference
            • ClusterRegistrationSpec
            • ClusterType
            • ClusterUnregistrationSpec
            • ConfigureConnectionApiResponse
            • ConnectionConfigurationSpec
            • ConnectionUnconfigurationSpec
            • CreateBackupTargetApiResponse
            • CreateRestoreSourceApiResponse
            • Credentials
            • DeleteBackupTargetApiResponse
            • DeleteRestoreSourceApiResponse
            • DomainManagerCloudType
            • DomainManagerRemoteClusterSpec
            • GetBackupTargetApiResponse
            • GetRestorePointApiResponse
            • GetRestoreSourceApiResponse
            • ListBackupTargetsApiResponse
            • ListRestorableDomainManagersApiResponse
            • ListRestorePointsApiResponse
            • ObjectStoreLocation
            • RegisterApiResponse
            • RemoteCluster
            • RemoteClusterSpec
            • RemoveRootCertificateApiResponse
            • RestorableDomainManager
            • RestoreApiResponse
            • RestorePoint
            • RestoreSource
            • RestoreSpec
            • RootCertRemoveSpec
            • RootCertificateAddSpec
            • S3Config
            • UnconfigureConnectionApiResponse
            • UnregisterApiResponse
            • UpdateBackupTargetApiResponse
          • operations package
            • ActionType
            • Batch
            • BatchCompletionStatus
            • BatchExecutionStatus
            • BatchSpec
            • BatchSpecMetadata
            • BatchSpecPayload
            • BatchSpecPayloadMetadata
            • BatchSpecPayloadMetadataHeader
            • BatchSpecPayloadMetadataPath
            • GetBatchApiResponse
            • ListBatchesApiResponse
            • SubmitBatchApiResponse
          • protectpc package
            • AddReplicasApiResponse
            • ApiError
            • ApiLink
            • ApiResponseMetadata
            • ApiSuccess
            • BackupTargets
            • BackupTargetsInfo
            • EligibleCluster
            • EligibleClusterList
            • FailedRecoveryPointDetails
            • FailedRecoveryPointsStats
            • ObjectStoreEndpointInfo
            • PEInfo
            • PcEndpointCredentials
            • PcEndpointFlavour
            • PcObjectStoreEndpoint
            • PcRestoreRootTask
            • PcvmRestoreFile
            • PcvmRestoreFiles
            • RecoverPcApiResponse
            • RecoveryStatus
            • RemoveReplicaResponse
            • ReplicaInfo
            • RestoreFilesApiResponse
            • RpoConfig
            • StopServicesApiResponse
            • UpdateCredentialApiResponse
            • UpdateRpoApiResponse
      • vmm package
        • v4 package
          • ahv package
            • config package
              • CloudInit
              • CloudInitDataSourceType
              • CustomKeyValues
              • Userdata
    • api_client
    • api_response
    • configuration
    • custom_retry
    • rest
  • ntnx_prism_py_client
  • response package
  • ApiLink

ApiLink#

class ApiLink(href=None, rel=None, *args, **kwargs)#

Bases: object

A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.

Parameters:
  • href – (href) The URL at which the entity described by the link can be accessed.

  • rel – (rel) A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of “self” identifies the URL for the object.

property href#

The URL at which the entity described by the link can be accessed.

Type:

str

property rel#

A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of “self” identifies the URL for the object.

Type:

str

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model

previous

response package

next

ApiResponseMetadata

© Copyright 2024, Nutanix.

Created using Sphinx 5.3.0.

Built with the PyData Sphinx Theme 0.13.0.