Skip to content

accesscontextmanager.v1beta1.accessContextManagerAccessLevel

Index

Fields

fn new

new(name)

new returns an instance of AccessContextManagerAccessLevel

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)

"Description of the AccessLevel and its use. Does not affect behavior."

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

fn spec.withTitle

withTitle(title)

"Human readable title. Must be unique within the Policy."

obj spec.accessPolicyRef

"The AccessContextManagerAccessPolicy this\nAccessContextManagerAccessLevel lives in."

fn spec.accessPolicyRef.withExternal

withExternal(external)

"Allowed value: string of the format accessPolicies/{{value}}, where {{value}} is the name field of an AccessContextManagerAccessPolicy resource."

fn spec.accessPolicyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.accessPolicyRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.basic

"A set of predefined conditions for the access level and a combining function."

fn spec.basic.withCombiningFunction

withCombiningFunction(combiningFunction)

"How the conditions list should be combined to determine if a request\nis granted this AccessLevel. If AND is used, each Condition in\nconditions must be satisfied for the AccessLevel to be applied. If\nOR is used, at least one Condition in conditions must be satisfied\nfor the AccessLevel to be applied. Default value: \"AND\" Possible values: [\"AND\", \"OR\"]."

fn spec.basic.withConditions

withConditions(conditions)

"A set of requirements for the AccessLevel to be granted."

fn spec.basic.withConditionsMixin

withConditionsMixin(conditions)

"A set of requirements for the AccessLevel to be granted."

Note: This function appends passed data to existing values

obj spec.basic.conditions

"A set of requirements for the AccessLevel to be granted."

fn spec.basic.conditions.withIpSubnetworks

withIpSubnetworks(ipSubnetworks)

"A list of CIDR block IP subnetwork specification. May be IPv4\nor IPv6.\nNote that for a CIDR IP address block, the specified IP address\nportion must be properly truncated (i.e. all the host bits must\nbe zero) or the input is considered malformed. For example,\n\"192.0.2.0/24\" is accepted but \"192.0.2.1/24\" is not. Similarly,\nfor IPv6, \"2001:db8::/32\" is accepted whereas \"2001:db8::1/32\"\nis not. The originating IP of a request must be in one of the\nlisted subnets in order for this Condition to be true.\nIf empty, all IP addresses are allowed."

fn spec.basic.conditions.withIpSubnetworksMixin

withIpSubnetworksMixin(ipSubnetworks)

"A list of CIDR block IP subnetwork specification. May be IPv4\nor IPv6.\nNote that for a CIDR IP address block, the specified IP address\nportion must be properly truncated (i.e. all the host bits must\nbe zero) or the input is considered malformed. For example,\n\"192.0.2.0/24\" is accepted but \"192.0.2.1/24\" is not. Similarly,\nfor IPv6, \"2001:db8::/32\" is accepted whereas \"2001:db8::1/32\"\nis not. The originating IP of a request must be in one of the\nlisted subnets in order for this Condition to be true.\nIf empty, all IP addresses are allowed."

Note: This function appends passed data to existing values

fn spec.basic.conditions.withMembers

withMembers(members)

fn spec.basic.conditions.withMembersMixin

withMembersMixin(members)

Note: This function appends passed data to existing values

fn spec.basic.conditions.withNegate

withNegate(negate)

"Whether to negate the Condition. If true, the Condition becomes\na NAND over its non-empty fields, each field must be false for\nthe Condition overall to be satisfied. Defaults to false."

fn spec.basic.conditions.withRegions

withRegions(regions)

"The request must originate from one of the provided\ncountries/regions.\nFormat: A valid ISO 3166-1 alpha-2 code."

fn spec.basic.conditions.withRegionsMixin

withRegionsMixin(regions)

"The request must originate from one of the provided\ncountries/regions.\nFormat: A valid ISO 3166-1 alpha-2 code."

Note: This function appends passed data to existing values

fn spec.basic.conditions.withRequiredAccessLevels

withRequiredAccessLevels(requiredAccessLevels)

fn spec.basic.conditions.withRequiredAccessLevelsMixin

withRequiredAccessLevelsMixin(requiredAccessLevels)

Note: This function appends passed data to existing values

obj spec.basic.conditions.devicePolicy

"Device specific restrictions, all restrictions must hold for\nthe Condition to be true. If not specified, all devices are\nallowed."

fn spec.basic.conditions.devicePolicy.withAllowedDeviceManagementLevels

withAllowedDeviceManagementLevels(allowedDeviceManagementLevels)

"A list of allowed device management levels.\nAn empty list allows all management levels. Possible values: [\"MANAGEMENT_UNSPECIFIED\", \"NONE\", \"BASIC\", \"COMPLETE\"]."

fn spec.basic.conditions.devicePolicy.withAllowedDeviceManagementLevelsMixin

withAllowedDeviceManagementLevelsMixin(allowedDeviceManagementLevels)

"A list of allowed device management levels.\nAn empty list allows all management levels. Possible values: [\"MANAGEMENT_UNSPECIFIED\", \"NONE\", \"BASIC\", \"COMPLETE\"]."

Note: This function appends passed data to existing values

fn spec.basic.conditions.devicePolicy.withAllowedEncryptionStatuses

withAllowedEncryptionStatuses(allowedEncryptionStatuses)

"A list of allowed encryptions statuses.\nAn empty list allows all statuses. Possible values: [\"ENCRYPTION_UNSPECIFIED\", \"ENCRYPTION_UNSUPPORTED\", \"UNENCRYPTED\", \"ENCRYPTED\"]."

fn spec.basic.conditions.devicePolicy.withAllowedEncryptionStatusesMixin

withAllowedEncryptionStatusesMixin(allowedEncryptionStatuses)

"A list of allowed encryptions statuses.\nAn empty list allows all statuses. Possible values: [\"ENCRYPTION_UNSPECIFIED\", \"ENCRYPTION_UNSUPPORTED\", \"UNENCRYPTED\", \"ENCRYPTED\"]."

Note: This function appends passed data to existing values

fn spec.basic.conditions.devicePolicy.withOsConstraints

withOsConstraints(osConstraints)

"A list of allowed OS versions.\nAn empty list allows all types and all versions."

fn spec.basic.conditions.devicePolicy.withOsConstraintsMixin

withOsConstraintsMixin(osConstraints)

"A list of allowed OS versions.\nAn empty list allows all types and all versions."

Note: This function appends passed data to existing values

fn spec.basic.conditions.devicePolicy.withRequireAdminApproval

withRequireAdminApproval(requireAdminApproval)

"Whether the device needs to be approved by the customer admin."

fn spec.basic.conditions.devicePolicy.withRequireCorpOwned

withRequireCorpOwned(requireCorpOwned)

"Whether the device needs to be corp owned."

fn spec.basic.conditions.devicePolicy.withRequireScreenLock

withRequireScreenLock(requireScreenLock)

"Whether or not screenlock is required for the DevicePolicy\nto be true. Defaults to false."

obj spec.basic.conditions.devicePolicy.osConstraints

"A list of allowed OS versions.\nAn empty list allows all types and all versions."

fn spec.basic.conditions.devicePolicy.osConstraints.withMinimumVersion

withMinimumVersion(minimumVersion)

"The minimum allowed OS version. If not set, any version\nof this OS satisfies the constraint.\nFormat: \"major.minor.patch\" such as \"10.5.301\", \"9.2.1\"."

fn spec.basic.conditions.devicePolicy.osConstraints.withOsType

withOsType(osType)

"The operating system type of the device. Possible values: [\"OS_UNSPECIFIED\", \"DESKTOP_MAC\", \"DESKTOP_WINDOWS\", \"DESKTOP_LINUX\", \"DESKTOP_CHROME_OS\", \"ANDROID\", \"IOS\"]."

fn spec.basic.conditions.devicePolicy.osConstraints.withRequireVerifiedChromeOs

withRequireVerifiedChromeOs(requireVerifiedChromeOs)

"If you specify DESKTOP_CHROME_OS for osType, you can optionally include requireVerifiedChromeOs to require Chrome Verified Access."

obj spec.basic.conditions.members

fn spec.basic.conditions.members.withUser

withUser(user)

obj spec.basic.conditions.members.serviceAccountRef

fn spec.basic.conditions.members.serviceAccountRef.withExternal

withExternal(external)

"Allowed value: string of the format serviceAccount:{{value}}, where {{value}} is the email field of an IAMServiceAccount resource."

fn spec.basic.conditions.members.serviceAccountRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.basic.conditions.members.serviceAccountRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.basic.conditions.requiredAccessLevels

fn spec.basic.conditions.requiredAccessLevels.withExternal

withExternal(external)

"Allowed value: The name field of an AccessContextManagerAccessLevel resource."

fn spec.basic.conditions.requiredAccessLevels.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.basic.conditions.requiredAccessLevels.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.custom

"Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request.\nSee CEL spec at: https://github.com/google/cel-spec."

obj spec.custom.expr

"Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language.\nThis page details the objects and attributes that are used to the build the CEL expressions for\ncustom access levels - https://cloud.google.com/access-context-manager/docs/custom-access-level-spec."

fn spec.custom.expr.withDescription

withDescription(description)

"Description of the expression."

fn spec.custom.expr.withExpression

withExpression(expression)

"Textual representation of an expression in Common Expression Language syntax."

fn spec.custom.expr.withLocation

withLocation(location)

"String indicating the location of the expression for error reporting, e.g. a file name and a position in the file."

fn spec.custom.expr.withTitle

withTitle(title)

"Title for the expression, i.e. a short string describing its purpose."