Docs
PackagesKubernetes v4.11.0 published on Thursday, Apr 18, 2024 by Pulumi
kubernetes.meta/v1.StatusPatch
Explore with Pulumi AI
Patch resources are used to modify existing Kubernetes resources by using Server-Side Apply updates. The name of the resource must be specified, but all other properties are optional. More than one patch may be applied to the same resource, and a random FieldManager name will be used for each Patch resource. Conflicts will result in an error by default, but can be forced using the “pulumi.com/patchForce” annotation. See the Server-Side Apply Docs for additional information about using Server-Side Apply to manage Kubernetes resources with Pulumi. Status is a return value for calls that don’t return other objects.
Create StatusPatch Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new StatusPatch(name: string, args?: StatusPatch, opts?: CustomResourceOptions);@overload
def StatusPatch(resource_name: str,
args: Optional[StatusPatchArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def StatusPatch(resource_name: str,
opts: Optional[ResourceOptions] = None,
code: Optional[int] = None,
details: Optional[StatusDetailsPatchArgs] = None,
message: Optional[str] = None,
metadata: Optional[ListMetaPatchArgs] = None,
reason: Optional[str] = None)func NewStatusPatch(ctx *Context, name string, args *StatusPatchArgs, opts ...ResourceOption) (*StatusPatch, error)public StatusPatch(string name, StatusPatchArgs? args = null, CustomResourceOptions? opts = null)
public StatusPatch(String name, StatusPatchArgs args)
public StatusPatch(String name, StatusPatchArgs args, CustomResourceOptions options)
type: kubernetes:meta/v1:StatusPatch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args StatusPatch
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args StatusPatchArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args StatusPatchArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StatusPatchArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StatusPatchArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
StatusPatch Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The StatusPatch resource accepts the following input properties:
- Code int
- Suggested HTTP return code for this status, 0 if not set.
- Details
Status
Details Patch - Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
- Message string
- A human-readable description of the status of this operation.
- Metadata
List
Meta Patch - Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- Reason string
- A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
- Code int
- Suggested HTTP return code for this status, 0 if not set.
- Details
Status
Details Patch Args - Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
- Message string
- A human-readable description of the status of this operation.
- Metadata
List
Meta Patch Args - Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- Reason string
- A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
- code Integer
- Suggested HTTP return code for this status, 0 if not set.
- details
Status
Details Patch - Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
- message String
- A human-readable description of the status of this operation.
- metadata
List
Meta Patch - Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- reason String
- A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
- code number
- Suggested HTTP return code for this status, 0 if not set.
- details
Status
Details Patch - Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
- message string
- A human-readable description of the status of this operation.
- metadata
List
Meta Patch - Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- reason string
- A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
- code int
- Suggested HTTP return code for this status, 0 if not set.
- details
Status
Details Patch Args - Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
- message str
- A human-readable description of the status of this operation.
- metadata
List
Meta Patch Args - Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- reason str
- A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
- code Number
- Suggested HTTP return code for this status, 0 if not set.
- details Property Map
- Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
- message String
- A human-readable description of the status of this operation.
- metadata Property Map
- Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- reason String
- A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
Outputs
All input properties are implicitly available as output properties. Additionally, the StatusPatch resource produces the following output properties:
Supporting Types
ListMetaPatch, ListMetaPatchArgs
- Continue string
- continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
- Remaining
Item intCount - remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
- Resource
Version string - String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- Self
Link string - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- Continue string
- continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
- Remaining
Item intCount - remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
- Resource
Version string - String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- Self
Link string - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- continue_ String
- continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
- remaining
Item IntegerCount - remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
- resource
Version String - String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- self
Link String - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- continue string
- continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
- remaining
Item numberCount - remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
- resource
Version string - String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- self
Link string - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- continue_ str
- continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
- remaining_
item_ intcount - remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
- resource_
version str - String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- self_
link str - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
- continue String
- continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
- remaining
Item NumberCount - remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
- resource
Version String - String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- self
Link String - Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
StatusCausePatch, StatusCausePatchArgs
- Field string
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
- Message string
- A human-readable description of the cause of the error. This field may be presented as-is to a reader.
- Reason string
- A machine-readable description of the cause of the error. If this value is empty there is no information available.
- Field string
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
- Message string
- A human-readable description of the cause of the error. This field may be presented as-is to a reader.
- Reason string
- A machine-readable description of the cause of the error. If this value is empty there is no information available.
- field String
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
- message String
- A human-readable description of the cause of the error. This field may be presented as-is to a reader.
- reason String
- A machine-readable description of the cause of the error. If this value is empty there is no information available.
- field string
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
- message string
- A human-readable description of the cause of the error. This field may be presented as-is to a reader.
- reason string
- A machine-readable description of the cause of the error. If this value is empty there is no information available.
- field str
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
- message str
- A human-readable description of the cause of the error. This field may be presented as-is to a reader.
- reason str
- A machine-readable description of the cause of the error. If this value is empty there is no information available.
- field String
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
- message String
- A human-readable description of the cause of the error. This field may be presented as-is to a reader.
- reason String
- A machine-readable description of the cause of the error. If this value is empty there is no information available.
StatusDetailsPatch, StatusDetailsPatchArgs
- Causes
List<Status
Cause Patch> - The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
- Group string
- The group attribute of the resource associated with the status StatusReason.
- Kind string
- The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- Name string
- The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
- Retry
After intSeconds - If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
- Uid string
- UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
- Causes
[]Status
Cause Patch - The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
- Group string
- The group attribute of the resource associated with the status StatusReason.
- Kind string
- The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- Name string
- The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
- Retry
After intSeconds - If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
- Uid string
- UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
- causes
List<Status
Cause Patch> - The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
- group String
- The group attribute of the resource associated with the status StatusReason.
- kind String
- The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- name String
- The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
- retry
After IntegerSeconds - If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
- uid String
- UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
- causes
Status
Cause Patch[] - The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
- group string
- The group attribute of the resource associated with the status StatusReason.
- kind string
- The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- name string
- The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
- retry
After numberSeconds - If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
- uid string
- UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
- causes
Sequence[Status
Cause Patch] - The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
- group str
- The group attribute of the resource associated with the status StatusReason.
- kind str
- The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- name str
- The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
- retry_
after_ intseconds - If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
- uid str
- UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
- causes List<Property Map>
- The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
- group String
- The group attribute of the resource associated with the status StatusReason.
- kind String
- The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- name String
- The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
- retry
After NumberSeconds - If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
- uid String
- UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
Package Details
- Repository
- Kubernetes pulumi/pulumi-kubernetes
- License
- Apache-2.0