replica_sets_scale
Creates, updates, deletes, gets or lists a replica_sets_scale resource.
Overview
| Name | replica_sets_scale |
| Type | Resource |
| Id | k8s.apps.replica_sets_scale |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
api_version | string | 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 (wire: apiVersion) |
kind | string | 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 |
metadata | object | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
spec | object | spec defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. |
status | object | status is the current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | name, namespace, protocol, cluster_addr | pretty | read scale of the specified ReplicaSet |
patch | update | name, namespace, protocol, cluster_addr | dry_run, field_manager, field_validation, force, pretty | partially update scale of the specified ReplicaSet |
replace | replace | name, namespace, protocol, cluster_addr | dry_run, field_manager, field_validation, pretty | replace scale of the specified ReplicaSet |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
cluster_addr | string | (default: localhost, x-stackQL-envVar: KUBE_HOST) |
name | string | name of the Scale |
namespace | string | object name and auth scope, such as for teams and projects |
protocol | string | (default: https, enum: [https, http], x-stackQL-envVar: KUBE_PROTOCOL) |
dry_run | string | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (wire: dryRun) |
field_manager | string | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (wire: fieldManager) |
field_validation | string | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (wire: fieldValidation) |
force | boolean | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
pretty | string | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
SELECT examples
- get
read scale of the specified ReplicaSet
SELECT
api_version,
kind,
metadata,
spec,
status
FROM k8s.apps.replica_sets_scale
WHERE name = '{{ name }}' -- required
AND namespace = '{{ namespace }}' -- required
AND protocol = '{{ protocol }}' -- required
AND cluster_addr = '{{ cluster_addr }}' -- required
AND pretty = '{{ pretty }}'
;
UPDATE examples
- patch
partially update scale of the specified ReplicaSet
UPDATE k8s.apps.replica_sets_scale
SET
-- No updatable properties
WHERE
name = '{{ name }}' --required
AND namespace = '{{ namespace }}' --required
AND protocol = '{{ protocol }}' --required
AND cluster_addr = '{{ cluster_addr }}' --required
AND dry_run = '{{ dry_run}}'
AND field_manager = '{{ field_manager}}'
AND field_validation = '{{ field_validation}}'
AND force = {{ force}}
AND pretty = '{{ pretty}}'
RETURNING
api_version,
kind,
metadata,
spec,
status;
REPLACE examples
- replace
replace scale of the specified ReplicaSet
REPLACE k8s.apps.replica_sets_scale
SET
api_version = '{{ api_version }}',
kind = '{{ kind }}',
metadata = '{{ metadata }}',
spec = '{{ spec }}',
status = '{{ status }}'
WHERE
name = '{{ name }}' --required
AND namespace = '{{ namespace }}' --required
AND protocol = '{{ protocol }}' --required
AND cluster_addr = '{{ cluster_addr }}' --required
AND dry_run = '{{ dry_run}}'
AND field_manager = '{{ field_manager}}'
AND field_validation = '{{ field_validation}}'
AND pretty = '{{ pretty}}'
RETURNING
api_version,
kind,
metadata,
spec,
status;