Watch
Watch initiates a server-side stream to monitor resource changes in real-time.
Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ”Define the version of the Connect protocol
Define the timeout, in ms
Request Body required
Section titled “Request Body required ”WatchRequest defines the parameters to start a streaming watch.
object
The target Kubernetes cluster identifier.
Kubernetes API Group (e.g., “apps” for Deployments, "" for core resources like Pods).
Kubernetes API Version (e.g., “v1”).
Kubernetes API Resource name in plural (e.g., “pods”, “deployments”).
The namespace to watch.
A selector to restrict watched objects by their labels.
A selector to restrict watched objects by their fields.
Start the watch from this specific resource version.
WatchRequest defines the parameters to start a streaming watch.
object
The target Kubernetes cluster identifier.
Kubernetes API Group (e.g., “apps” for Deployments, "" for core resources like Pods).
Kubernetes API Version (e.g., “v1”).
Kubernetes API Resource name in plural (e.g., “pods”, “deployments”).
The namespace to watch.
A selector to restrict watched objects by their labels.
A selector to restrict watched objects by their fields.
Start the watch from this specific resource version.
WatchRequest defines the parameters to start a streaming watch.
object
The target Kubernetes cluster identifier.
Kubernetes API Group (e.g., “apps” for Deployments, "" for core resources like Pods).
Kubernetes API Version (e.g., “v1”).
Kubernetes API Resource name in plural (e.g., “pods”, “deployments”).
The namespace to watch.
A selector to restrict watched objects by their labels.
A selector to restrict watched objects by their fields.
Start the watch from this specific resource version.
WatchRequest defines the parameters to start a streaming watch.
object
The target Kubernetes cluster identifier.
Kubernetes API Group (e.g., “apps” for Deployments, "" for core resources like Pods).
Kubernetes API Version (e.g., “v1”).
Kubernetes API Resource name in plural (e.g., “pods”, “deployments”).
The namespace to watch.
A selector to restrict watched objects by their labels.
A selector to restrict watched objects by their fields.
Start the watch from this specific resource version.
WatchRequest defines the parameters to start a streaming watch.
object
The target Kubernetes cluster identifier.
Kubernetes API Group (e.g., “apps” for Deployments, "" for core resources like Pods).
Kubernetes API Version (e.g., “v1”).
Kubernetes API Resource name in plural (e.g., “pods”, “deployments”).
The namespace to watch.
A selector to restrict watched objects by their labels.
A selector to restrict watched objects by their fields.
Start the watch from this specific resource version.
WatchRequest defines the parameters to start a streaming watch.
object
The target Kubernetes cluster identifier.
Kubernetes API Group (e.g., “apps” for Deployments, "" for core resources like Pods).
Kubernetes API Version (e.g., “v1”).
Kubernetes API Resource name in plural (e.g., “pods”, “deployments”).
The namespace to watch.
A selector to restrict watched objects by their labels.
A selector to restrict watched objects by their fields.
Start the watch from this specific resource version.
WatchRequest defines the parameters to start a streaming watch.
object
The target Kubernetes cluster identifier.
Kubernetes API Group (e.g., “apps” for Deployments, "" for core resources like Pods).
Kubernetes API Version (e.g., “v1”).
Kubernetes API Resource name in plural (e.g., “pods”, “deployments”).
The namespace to watch.
A selector to restrict watched objects by their labels.
A selector to restrict watched objects by their fields.
Start the watch from this specific resource version.
WatchRequest defines the parameters to start a streaming watch.
object
The target Kubernetes cluster identifier.
Kubernetes API Group (e.g., “apps” for Deployments, "" for core resources like Pods).
Kubernetes API Version (e.g., “v1”).
Kubernetes API Resource name in plural (e.g., “pods”, “deployments”).
The namespace to watch.
A selector to restrict watched objects by their labels.
A selector to restrict watched objects by their fields.
Start the watch from this specific resource version.
Responses
Section titled “ Responses ”Success
WatchEvent represents a single change notification from the Kubernetes API.
object
The type of the watch event.
The state of the resource associated with the event.
The resourceVersion of the watch event, used to initiate a Watch from a specific point in time.
WatchEvent represents a single change notification from the Kubernetes API.
object
The type of the watch event.
The state of the resource associated with the event.
The resourceVersion of the watch event, used to initiate a Watch from a specific point in time.
WatchEvent represents a single change notification from the Kubernetes API.
object
The type of the watch event.
The state of the resource associated with the event.
The resourceVersion of the watch event, used to initiate a Watch from a specific point in time.
WatchEvent represents a single change notification from the Kubernetes API.
object
The type of the watch event.
The state of the resource associated with the event.
The resourceVersion of the watch event, used to initiate a Watch from a specific point in time.
WatchEvent represents a single change notification from the Kubernetes API.
object
The type of the watch event.
The state of the resource associated with the event.
The resourceVersion of the watch event, used to initiate a Watch from a specific point in time.
WatchEvent represents a single change notification from the Kubernetes API.
object
The type of the watch event.
The state of the resource associated with the event.
The resourceVersion of the watch event, used to initiate a Watch from a specific point in time.
WatchEvent represents a single change notification from the Kubernetes API.
object
The type of the watch event.
The state of the resource associated with the event.
The resourceVersion of the watch event, used to initiate a Watch from a specific point in time.
WatchEvent represents a single change notification from the Kubernetes API.
object
The type of the watch event.
The state of the resource associated with the event.
The resourceVersion of the watch event, used to initiate a Watch from a specific point in time.
default
Section titled “default ”Error
Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is no limit on the number of messages.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
object
A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.
The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.
Detailed error information.
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is no limit on the number of messages.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
object
A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.
The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.
Detailed error information.
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is no limit on the number of messages.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
object
A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.
The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.
Detailed error information.
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is no limit on the number of messages.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
object
A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.
The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.
Detailed error information.
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is no limit on the number of messages.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
object
A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.
The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.
Detailed error information.
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is no limit on the number of messages.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
object
A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.
The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.
Detailed error information.
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is no limit on the number of messages.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
object
A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.
The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.
Detailed error information.
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is no limit on the number of messages.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.
object
A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.
The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.
Detailed error information.