Packages

final class Live extends Service

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Live
  2. Service
  3. ClusterResourceStatus
  4. ClusterResourceDeleteAll
  5. ClusterResourceDelete
  6. ClusterResource
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val asGeneric: ZEnvironment[Generic]
    Definition Classes
    Service
  5. val asGenericResource: Resource[VolumeAttachment]

    A more generic interface for the same resource

    A more generic interface for the same resource

    Definition Classes
    LiveClusterResource
  6. val asGenericResourceDelete: ResourceDelete[VolumeAttachment, VolumeAttachment]
    Definition Classes
    LiveClusterResourceDelete
  7. val asGenericResourceDeleteAll: ResourceDeleteAll[VolumeAttachment]

    A more generic interface for the same resource

    A more generic interface for the same resource

    Definition Classes
    LiveClusterResourceDeleteAll
  8. val asGenericResourceStatus: ResourceStatus[VolumeAttachmentStatus, VolumeAttachment]

    A more generic interface for the same resource

    A more generic interface for the same resource

    Definition Classes
    LiveClusterResourceStatus
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  11. def create(newResource: VolumeAttachment, dryRun: Boolean = false): IO[K8sFailure, VolumeAttachment]

    Creates a new resource

    Creates a new resource

    newResource

    The new resource to define in the cluster.

    dryRun

    If true, the request is sent to the server but it will not create the resource.

    returns

    Returns the created resource as it was returned from Kubernetes

    Definition Classes
    ClusterResource
  12. def delete(name: String, deleteOptions: DeleteOptions, dryRun: Boolean = false, gracePeriod: Option[zio.Duration] = None, propagationPolicy: Option[PropagationPolicy] = None): IO[K8sFailure, VolumeAttachment]

    Deletes an existing resource selected by its name

    Deletes an existing resource selected by its name

    name

    Name of the resource

    deleteOptions

    Delete options

    dryRun

    If true, the request is sent to the server but it will not create the resource.

    gracePeriod

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    propagationPolicy

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

    returns

    Response from the Kubernetes API

    Definition Classes
    ClusterResourceDelete
  13. def deleteAll(deleteOptions: DeleteOptions, dryRun: Boolean = false, gracePeriod: Option[zio.Duration] = None, propagationPolicy: Option[PropagationPolicy] = None, fieldSelector: Option[FieldSelector] = None, labelSelector: Option[LabelSelector] = None): IO[K8sFailure, Status]

    Delete all resources matching the provided constraints

    Delete all resources matching the provided constraints

    deleteOptions

    Delete options

    dryRun

    If true, the request is sent to the server but it will not create the resource.

    gracePeriod

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    propagationPolicy

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

    fieldSelector

    Select the items to be deleted by field selectors. Not all fields are supported by the server.

    labelSelector

    Select the items to be deleted by label selectors.

    returns

    Status returned by the Kubernetes API

    Definition Classes
    ClusterResourceDeleteAll
  14. def deleteAndWait(name: String, deleteOptions: DeleteOptions, dryRun: Boolean = false, gracePeriod: Option[zio.Duration] = None, propagationPolicy: Option[PropagationPolicy] = None)(implicit ev: <:<[VolumeAttachment, Status]): ZIO[Any, K8sFailure, Unit]

    Deletes an existing resource selected by its name and waits until it has gone

    Deletes an existing resource selected by its name and waits until it has gone

    name

    Name of the resource

    deleteOptions

    Delete options

    dryRun

    If true, the request is sent to the server but it will not create the resource.

    gracePeriod

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    propagationPolicy

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

    Definition Classes
    ClusterResourceDelete
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def get(name: String): IO[K8sFailure, VolumeAttachment]

    Get a resource by its name

    Get a resource by its name

    name

    Name of the resource

    returns

    Returns the current version of the resource

    Definition Classes
    ClusterResource
  18. def getAll(chunkSize: Int = 10, fieldSelector: Option[FieldSelector] = None, labelSelector: Option[LabelSelector] = None, resourceVersion: ListResourceVersion = ListResourceVersion.MostRecent): Stream[K8sFailure, VolumeAttachment]

    A paginated query of all resources with filtering possibilities

    A paginated query of all resources with filtering possibilities

    chunkSize

    Number of items to return per HTTP request

    fieldSelector

    Constrain the returned items by field selectors. Not all fields are supported by the server.

    labelSelector

    Constrain the returned items by label selectors.

    resourceVersion

    Control the returned resources' version.

    returns

    A stream of resources

    Definition Classes
    ClusterResource
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def getStatus(name: String): IO[K8sFailure, VolumeAttachment]

    Get the status of a given subresource by name

    Get the status of a given subresource by name

    name

    Name of the resource

    returns

    Returns the full resource object but with possibly the non-status fields absent.

    Definition Classes
    ClusterResourceStatus
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def replace(name: String, updatedResource: VolumeAttachment, dryRun: Boolean = false): IO[K8sFailure, VolumeAttachment]

    Replaces an existing resource selected by its name

    Replaces an existing resource selected by its name

    name

    Name of the resource

    updatedResource

    The new value of the resource

    dryRun

    If true, the request is sent to the server but it will not create the resource.

    returns

    Returns the updated resource as it was returned from Kubernetes

    Definition Classes
    ClusterResource
  27. def replaceStatus(of: VolumeAttachment, updatedStatus: VolumeAttachmentStatus, dryRun: Boolean = false): IO[K8sFailure, VolumeAttachment]

    Replaces the status of a resource that was previously get from server.

    Replaces the status of a resource that was previously get from server.

    Use either getStatus or ClusterResource.get to retrieve a value of the resource by name, and then call this method to update its status.

    of

    The resource object to manipulate

    updatedStatus

    Updated status value

    dryRun

    If true, the request is sent to the server but it will not create the resource.

    returns

    Returns the updated resource (not just the status)

    Definition Classes
    ClusterResourceStatus
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def watch(resourceVersion: Option[String], fieldSelector: Option[FieldSelector] = None, labelSelector: Option[LabelSelector] = None): Stream[K8sFailure, TypedWatchEvent[VolumeAttachment]]

    Watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent

    Watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent

    This function requires the user to control the starting resourceVersion and to restart the watch stream when the server closes the connection.

    For a more convenient variant check watchForever.

    resourceVersion

    Last known resource version

    fieldSelector

    Constrain the returned items by field selectors. Not all fields are supported by the server.

    labelSelector

    Constrain the returned items by label selectors.

    returns

    A stream of watch events

    Definition Classes
    ClusterResource
  34. def watchForever(resourceVersion: Option[String] = None, fieldSelector: Option[FieldSelector] = None, labelSelector: Option[LabelSelector] = None): ZStream[Any, K8sFailure, TypedWatchEvent[VolumeAttachment]]

    Infinite watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent

    Infinite watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent

    The underlying implementation takes advantage of Kubernetes watch bookmarks.

    fieldSelector

    Constrain the returned items by field selectors. Not all fields are supported by the server.

    labelSelector

    Constrain the returned items by label selectors.

    returns

    A stream of watch events

    Definition Classes
    ClusterResource

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Ungrouped