FileWatch v1alpha1

apiVersion: tilt.dev/v1alpha1

import "github.com/tilt-dev/tilt/pkg/apis/core/v1alpha1"

FileWatch

FileWatch


FileWatchSpec

FileWatchSpec defines the desired state of FileWatch


  • watchedPaths ([]string), required

    WatchedPaths are paths of directories or files to watch for changes to. It cannot be empty.

  • ignores ([]IgnoreDef)

    Ignores are optional rules to filter out a subset of changes matched by WatchedPaths.

    **

    • ignores.basePath (string), required

      BasePath is the base path for the patterns. It cannot be empty.

      If no patterns are specified, everything under it will be recursively ignored.

    • ignores.patterns ([]string)

      Patterns are dockerignore style rules. Absolute-style patterns will be rooted to the BasePath.

      See https://docs.docker.com/engine/reference/builder/#dockerignore-file.

FileWatchStatus

FileWatchStatus defines the observed state of FileWatch


  • error (string)

    Error is set if there is a problem with the filesystem watch. If non-empty, consumers should assume that no filesystem events will be seen and that the file watcher is in a failed state.

  • fileEvents ([]FileEvent)

    FileEvents summarizes batches of file changes (create, modify, or delete) that have been seen in ascending chronological order. Only the most recent 20 events are included.

    **

    • fileEvents.seenFiles ([]string), required

      SeenFiles is a list of paths which changed (create, modify, or delete).

    • fileEvents.time (MicroTime), required

      Time is an approximate timestamp for a batch of file changes.

      This will NOT exactly match any inode attributes (e.g. ctime, mtime) at the filesystem level and is purely informational or for use as an opaque watermark.

      MicroTime is version of Time with microsecond level precision.

  • lastEventTime (MicroTime)

    LastEventTime is the timestamp of the most recent file event. It is zero if no events have been seen yet.

    If the specifics of which files changed are not important, this field can be used as a watermark without needing to inspect FileEvents.

    MicroTime is version of Time with microsecond level precision.

  • monitorStartTime (MicroTime)

    MonitorStartTime is the timestamp of when filesystem monitor was started. It is zero if the monitor has not been started yet.

    MicroTime is version of Time with microsecond level precision.

FileWatchList

FileWatchList


  • apiVersion: tilt.dev/v1alpha1

  • kind: FileWatchList

  • metadata (ListMeta)

  • items ([]FileWatch), required

Operations


get read the specified FileWatch

HTTP Request

GET /apis/tilt.dev/v1alpha1/filewatches/{name}

Parameters

  • name (in path): string, required

    name of the FileWatch

  • pretty (in query): string

    pretty

Response

200 (FileWatch): OK

get read status of the specified FileWatch

HTTP Request

GET /apis/tilt.dev/v1alpha1/filewatches/{name}/status

Parameters

  • name (in path): string, required

    name of the FileWatch

  • pretty (in query): string

    pretty

Response

200 (FileWatch): OK

list list or watch objects of kind FileWatch

HTTP Request

GET /apis/tilt.dev/v1alpha1/filewatches

Parameters

  • allowWatchBookmarks (in query): boolean

    allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

  • continue (in query): string

    continue

  • fieldSelector (in query): string

    fieldSelector

  • labelSelector (in query): string

    labelSelector

  • limit (in query): integer

    limit

  • pretty (in query): string

    pretty

  • resourceVersion (in query): string

    resourceVersion

  • resourceVersionMatch (in query): string

    resourceVersionMatch

  • timeoutSeconds (in query): integer

    timeoutSeconds

  • watch (in query): boolean

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

200 (FileWatchList): OK

create create a FileWatch

HTTP Request

POST /apis/tilt.dev/v1alpha1/filewatches

Parameters

Response

200 (FileWatch): OK

201 (FileWatch): Created

202 (FileWatch): Accepted

update replace the specified FileWatch

HTTP Request

PUT /apis/tilt.dev/v1alpha1/filewatches/{name}

Parameters

  • name (in path): string, required

    name of the FileWatch

  • body: FileWatch, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • pretty (in query): string

    pretty

Response

200 (FileWatch): OK

201 (FileWatch): Created

update replace status of the specified FileWatch

HTTP Request

PUT /apis/tilt.dev/v1alpha1/filewatches/{name}/status

Parameters

  • name (in path): string, required

    name of the FileWatch

  • body: FileWatch, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • pretty (in query): string

    pretty

Response

200 (FileWatch): OK

201 (FileWatch): Created

patch partially update the specified FileWatch

HTTP Request

PATCH /apis/tilt.dev/v1alpha1/filewatches/{name}

Parameters

  • name (in path): string, required

    name of the FileWatch

  • body: Patch, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • force (in query): boolean

    force

  • pretty (in query): string

    pretty

Response

200 (FileWatch): OK

patch partially update status of the specified FileWatch

HTTP Request

PATCH /apis/tilt.dev/v1alpha1/filewatches/{name}/status

Parameters

  • name (in path): string, required

    name of the FileWatch

  • body: Patch, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • force (in query): boolean

    force

  • pretty (in query): string

    pretty

Response

200 (FileWatch): OK

delete delete a FileWatch

HTTP Request

DELETE /apis/tilt.dev/v1alpha1/filewatches/{name}

Parameters

Response

200 (Status): OK

202 (Status): Accepted

deletecollection delete collection of FileWatch

HTTP Request

DELETE /apis/tilt.dev/v1alpha1/filewatches

Parameters

Response

200 (Status): OK