Skip to content

compute.v1beta1.computeResourcePolicy

Index

Fields

fn new

new(name)

new returns an instance of ComputeResourcePolicy

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"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: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"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: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"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."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"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."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"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."

fn metadata.withFinalizers

withFinalizers(finalizers)

"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."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"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."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"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: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"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: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"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: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"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.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"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."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"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."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"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.\n\nPopulated 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"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"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.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

fn spec.withDescription

withDescription(description)

"Immutable. An optional description of this resource. Provide this property when you create the resource."

fn spec.withRegion

withRegion(region)

"Immutable. Region where resource policy resides."

fn spec.withResourceID

withResourceID(resourceID)

"Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of metadata.name is used as the default."

obj spec.groupPlacementPolicy

"Immutable. Resource policy for instances used for placement configuration."

fn spec.groupPlacementPolicy.withAvailabilityDomainCount

withAvailabilityDomainCount(availabilityDomainCount)

"Immutable. The number of availability domains instances will be spread across. If two instances are in different\navailability domain, they will not be put in the same low latency network."

fn spec.groupPlacementPolicy.withCollocation

withCollocation(collocation)

"Immutable. Collocation specifies whether to place VMs inside the same availability domain on the same low-latency network.\nSpecify 'COLLOCATED' to enable collocation. Can only be specified with 'vm_count'. If compute instances are created\nwith a COLLOCATED policy, then exactly 'vm_count' instances must be created at the same time with the resource policy\nattached. Possible values: [\"COLLOCATED\"]."

fn spec.groupPlacementPolicy.withVmCount

withVmCount(vmCount)

"Immutable. Number of vms in this placement group."

obj spec.instanceSchedulePolicy

"Immutable. Resource policy for scheduling instance operations."

fn spec.instanceSchedulePolicy.withExpirationTime

withExpirationTime(expirationTime)

"Immutable. The expiration time of the schedule. The timestamp is an RFC3339 string."

fn spec.instanceSchedulePolicy.withStartTime

withStartTime(startTime)

"Immutable. The start time of the schedule. The timestamp is an RFC3339 string."

fn spec.instanceSchedulePolicy.withTimeZone

withTimeZone(timeZone)

"Immutable. Specifies the time zone to be used in interpreting the schedule. The value of this field must be a time zone name\nfrom the tz database: http://en.wikipedia.org/wiki/Tz_database."

obj spec.instanceSchedulePolicy.vmStartSchedule

"Immutable. Specifies the schedule for starting instances."

fn spec.instanceSchedulePolicy.vmStartSchedule.withSchedule

withSchedule(schedule)

"Immutable. Specifies the frequency for the operation, using the unix-cron format."

obj spec.instanceSchedulePolicy.vmStopSchedule

"Immutable. Specifies the schedule for stopping instances."

fn spec.instanceSchedulePolicy.vmStopSchedule.withSchedule

withSchedule(schedule)

"Immutable. Specifies the frequency for the operation, using the unix-cron format."

obj spec.snapshotSchedulePolicy

"Immutable. Policy for creating snapshots of persistent disks."

obj spec.snapshotSchedulePolicy.retentionPolicy

"Immutable. Retention policy applied to snapshots created by this resource policy."

fn spec.snapshotSchedulePolicy.retentionPolicy.withMaxRetentionDays

withMaxRetentionDays(maxRetentionDays)

"Immutable. Maximum age of the snapshot that is allowed to be kept."

fn spec.snapshotSchedulePolicy.retentionPolicy.withOnSourceDiskDelete

withOnSourceDiskDelete(onSourceDiskDelete)

"Immutable. Specifies the behavior to apply to scheduled snapshots when\nthe source disk is deleted. Default value: \"KEEP_AUTO_SNAPSHOTS\" Possible values: [\"KEEP_AUTO_SNAPSHOTS\", \"APPLY_RETENTION_POLICY\"]."

obj spec.snapshotSchedulePolicy.schedule

"Immutable. Contains one of an 'hourlySchedule', 'dailySchedule', or 'weeklySchedule'."

obj spec.snapshotSchedulePolicy.schedule.dailySchedule

"Immutable. The policy will execute every nth day at the specified time."

fn spec.snapshotSchedulePolicy.schedule.dailySchedule.withDaysInCycle

withDaysInCycle(daysInCycle)

"Immutable. The number of days between snapshots."

fn spec.snapshotSchedulePolicy.schedule.dailySchedule.withStartTime

withStartTime(startTime)

"Immutable. This must be in UTC format that resolves to one of\n00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example,\nboth 13:00-5 and 08:00 are valid."

obj spec.snapshotSchedulePolicy.schedule.hourlySchedule

"Immutable. The policy will execute every nth hour starting at the specified time."

fn spec.snapshotSchedulePolicy.schedule.hourlySchedule.withHoursInCycle

withHoursInCycle(hoursInCycle)

"Immutable. The number of hours between snapshots."

fn spec.snapshotSchedulePolicy.schedule.hourlySchedule.withStartTime

withStartTime(startTime)

"Immutable. Time within the window to start the operations.\nIt must be in an hourly format \"HH:MM\",\nwhere HH : [00-23] and MM : [00] GMT.\neg: 21:00."

obj spec.snapshotSchedulePolicy.schedule.weeklySchedule

"Immutable. Allows specifying a snapshot time for each day of the week."

fn spec.snapshotSchedulePolicy.schedule.weeklySchedule.withDayOfWeeks

withDayOfWeeks(dayOfWeeks)

"Immutable. May contain up to seven (one for each day of the week) snapshot times."

fn spec.snapshotSchedulePolicy.schedule.weeklySchedule.withDayOfWeeksMixin

withDayOfWeeksMixin(dayOfWeeks)

"Immutable. May contain up to seven (one for each day of the week) snapshot times."

Note: This function appends passed data to existing values

obj spec.snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks

"Immutable. May contain up to seven (one for each day of the week) snapshot times."

fn spec.snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks.withDay

withDay(day)

"Immutable. The day of the week to create the snapshot. e.g. MONDAY Possible values: [\"MONDAY\", \"TUESDAY\", \"WEDNESDAY\", \"THURSDAY\", \"FRIDAY\", \"SATURDAY\", \"SUNDAY\"]."

fn spec.snapshotSchedulePolicy.schedule.weeklySchedule.dayOfWeeks.withStartTime

withStartTime(startTime)

"Immutable. Time within the window to start the operations.\nIt must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT."

obj spec.snapshotSchedulePolicy.snapshotProperties

"Immutable. Properties with which the snapshots are created, such as labels."

fn spec.snapshotSchedulePolicy.snapshotProperties.withGuestFlush

withGuestFlush(guestFlush)

"Immutable. Whether to perform a 'guest aware' snapshot."

fn spec.snapshotSchedulePolicy.snapshotProperties.withLabels

withLabels(labels)

"Immutable. A set of key-value pairs."

fn spec.snapshotSchedulePolicy.snapshotProperties.withLabelsMixin

withLabelsMixin(labels)

"Immutable. A set of key-value pairs."

Note: This function appends passed data to existing values

fn spec.snapshotSchedulePolicy.snapshotProperties.withStorageLocations

withStorageLocations(storageLocations)

"Immutable. Cloud Storage bucket location to store the auto snapshot\n(regional or multi-regional)."

fn spec.snapshotSchedulePolicy.snapshotProperties.withStorageLocationsMixin

withStorageLocationsMixin(storageLocations)

"Immutable. Cloud Storage bucket location to store the auto snapshot\n(regional or multi-regional)."

Note: This function appends passed data to existing values