flowcontrol.apiserver.k8s.io/FlowSchema@v1

Properties

Property	Type	Attributes	Description
metadata	IoK8SApimachineryPkgApisMetaV1ObjectMeta	Required, Identifier	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
apiVersion	'flowcontrol.apiserver.k8s.io/v1'	Read-only, Deploy-time constant	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind	'FlowSchema'	Read-only, Deploy-time constant	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
spec	IoK8SApiFlowcontrolV1FlowSchemaSpec		FlowSchemaSpec describes how the FlowSchema's specification looks like.
status	IoK8SApiFlowcontrolV1FlowSchemaStatus		FlowSchemaStatus represents the current state of a FlowSchema.

IoK8SApimachineryPkgApisMetaV1ObjectMeta

Property	Type	Attributes	Description
name	string	Required, Deploy-time constant, Identifier	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
annotations	IoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotations		Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
creationTimestamp	string	Read-only	Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
deletionGracePeriodSeconds	int	Read-only	Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletionTimestamp	string	Read-only	Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
finalizers	string[]		Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
generation	int	Read-only	A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
labels	IoK8SApimachineryPkgApisMetaV1ObjectMetaLabels		Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
managedFields	IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry[]	Read-only	ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
namespace	string	Deploy-time constant, Identifier	Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
ownerReferences	IoK8SApimachineryPkgApisMetaV1OwnerReference[]		List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
resourceVersion	string	Read-only	An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
selfLink	string	Read-only	Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
uid	string	Read-only	UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

IoK8SApiFlowcontrolV1FlowSchemaSpec

Property	Type	Attributes	Description
priorityLevelConfiguration	IoK8SApiFlowcontrolV1PriorityLevelConfigurationReference	Required	PriorityLevelConfigurationReference contains information that points to the "request-priority" being used.
distinguisherMethod	IoK8SApiFlowcontrolV1FlowDistinguisherMethod		FlowDistinguisherMethod specifies the method of a flow distinguisher.
matchingPrecedence	int		`matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default.
rules	IoK8SApiFlowcontrolV1PolicyRulesWithSubjects[]		`rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema.

IoK8SApiFlowcontrolV1FlowSchemaStatus

Property	Type	Attributes	Description
conditions	IoK8SApiFlowcontrolV1FlowSchemaCondition[]		`conditions` is a list of the current states of FlowSchema.

IoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotations

Additional properties of type string are allowed.

IoK8SApimachineryPkgApisMetaV1ObjectMetaLabels

Additional properties of type string are allowed.

IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry

Property	Type	Attributes	Description
apiVersion	string		APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
fieldsType	string		FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1	any		Any object
manager	string		Manager is an identifier of the workflow managing these fields.
operation	string		Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresource	string		Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
time	string		Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

IoK8SApimachineryPkgApisMetaV1OwnerReference

Property	Type	Attributes	Description
apiVersion	string	Required	API version of the referent.
kind	string	Required	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name	string	Required	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid	string	Required	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
blockOwnerDeletion	bool		If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller	bool		If true, this reference points to the managing controller.

IoK8SApiFlowcontrolV1PriorityLevelConfigurationReference

Property	Type	Attributes	Description
name	string	Required	`name` is the name of the priority level configuration being referenced Required.

IoK8SApiFlowcontrolV1FlowDistinguisherMethod

Property	Type	Attributes	Description
type	string	Required	`type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required.

IoK8SApiFlowcontrolV1PolicyRulesWithSubjects

Property	Type	Attributes	Description
subjects	IoK8SApiFlowcontrolV1Subject[]	Required	subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required.
nonResourceRules	IoK8SApiFlowcontrolV1NonResourcePolicyRule[]		`nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL.
resourceRules	IoK8SApiFlowcontrolV1ResourcePolicyRule[]		`resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty.

IoK8SApiFlowcontrolV1FlowSchemaCondition

Property	Type	Attributes	Description
lastTransitionTime	string		Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
message	string		`message` is a human-readable message indicating details about last transition.
reason	string		`reason` is a unique, one-word, CamelCase reason for the condition's last transition.
status	string		`status` is the status of the condition. Can be True, False, Unknown. Required.
type	string		`type` is the type of the condition. Required.

IoK8SApiFlowcontrolV1Subject

Property	Type	Attributes	Description
kind	string	Required	`kind` indicates which one of the other fields is non-empty. Required
group	IoK8SApiFlowcontrolV1GroupSubject		GroupSubject holds detailed information for group-kind subject.
serviceAccount	IoK8SApiFlowcontrolV1ServiceAccountSubject		ServiceAccountSubject holds detailed information for service-account-kind subject.
user	IoK8SApiFlowcontrolV1UserSubject		UserSubject holds detailed information for user-kind subject.

IoK8SApiFlowcontrolV1NonResourcePolicyRule

Property	Type	Attributes	Description
nonResourceURLs	string[]	Required	`nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example: - "/healthz" is legal - "/hea*" is illegal - "/hea" is legal but matches nothing - "/hea/" also matches nothing - "/healthz/" matches all per-component health checks. "*" matches all non-resource urls. if it is present, it must be the only entry. Required.
verbs	string[]	Required	`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required.

IoK8SApiFlowcontrolV1ResourcePolicyRule

Property	Type	Attributes	Description
apiGroups	string[]	Required	`apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.
resources	string[]	Required	`resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.
verbs	string[]	Required	`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.
clusterScope	bool		`clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list.
namespaces	string[]		`namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "". Note that "" matches any specified namespace but does not match a request that does not specify a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true.

IoK8SApiFlowcontrolV1GroupSubject

Property	Type	Attributes	Description
name	string	Required	name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required.

IoK8SApiFlowcontrolV1ServiceAccountSubject

Property	Type	Attributes	Description
name	string	Required	`name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required.
namespace	string	Required	`namespace` is the namespace of matching ServiceAccount objects. Required.

IoK8SApiFlowcontrolV1UserSubject

Property	Type	Attributes	Description
name	string	Required	`name` is the username that matches, or "*" to match all usernames. Required.