Package Classes (0.5.12)

Summary of entries of Classes for edgecontainer.

Classes

EdgeContainerAsyncClient

EdgeContainer API provides management of Kubernetes Clusters on Google Edge Cloud deployments.

EdgeContainerClient

EdgeContainer API provides management of Kubernetes Clusters on Google Edge Cloud deployments.

ListClustersAsyncPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __aiter__ method to iterate through its clusters field.

If there are more pages, the __aiter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListClustersPager

A pager for iterating through list_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __iter__ method to iterate through its clusters field.

If there are more pages, the __iter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListMachinesAsyncPager

A pager for iterating through list_machines requests.

This class thinly wraps an initial ListMachinesResponse object, and provides an __aiter__ method to iterate through its machines field.

If there are more pages, the __aiter__ method will make additional ListMachines requests and continue to iterate through the machines field on the corresponding responses.

All the usual ListMachinesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListMachinesPager

A pager for iterating through list_machines requests.

This class thinly wraps an initial ListMachinesResponse object, and provides an __iter__ method to iterate through its machines field.

If there are more pages, the __iter__ method will make additional ListMachines requests and continue to iterate through the machines field on the corresponding responses.

All the usual ListMachinesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListNodePoolsAsyncPager

A pager for iterating through list_node_pools requests.

This class thinly wraps an initial ListNodePoolsResponse object, and provides an __aiter__ method to iterate through its node_pools field.

If there are more pages, the __aiter__ method will make additional ListNodePools requests and continue to iterate through the node_pools field on the corresponding responses.

All the usual ListNodePoolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListNodePoolsPager

A pager for iterating through list_node_pools requests.

This class thinly wraps an initial ListNodePoolsResponse object, and provides an __iter__ method to iterate through its node_pools field.

If there are more pages, the __iter__ method will make additional ListNodePools requests and continue to iterate through the node_pools field on the corresponding responses.

All the usual ListNodePoolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListVpnConnectionsAsyncPager

A pager for iterating through list_vpn_connections requests.

This class thinly wraps an initial ListVpnConnectionsResponse object, and provides an __aiter__ method to iterate through its vpn_connections field.

If there are more pages, the __aiter__ method will make additional ListVpnConnections requests and continue to iterate through the vpn_connections field on the corresponding responses.

All the usual ListVpnConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListVpnConnectionsPager

A pager for iterating through list_vpn_connections requests.

This class thinly wraps an initial ListVpnConnectionsResponse object, and provides an __iter__ method to iterate through its vpn_connections field.

If there are more pages, the __iter__ method will make additional ListVpnConnections requests and continue to iterate through the vpn_connections field on the corresponding responses.

All the usual ListVpnConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Authorization

RBAC policy that will be applied and managed by GEC.

ChannelConfig

Configuration for a release channel.

Cluster

A Google Distributed Cloud Edge Kubernetes cluster.

ControlPlane

Configuration of the cluster control plane.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Local

Configuration specific to clusters with a control plane hosted locally. Warning: Local control plane clusters must be created in their own project. Local control plane clusters cannot coexist in the same project with any other type of clusters, including non-GDCE clusters. Mixing local control plane GDCE clusters with any other type of clusters in the same project can result in data loss.

Remote

Configuration specific to clusters with a control plane hosted remotely.

SharedDeploymentPolicy

Represents the policy configuration about how user applications are deployed.

ControlPlaneEncryption

Configuration for Customer-managed KMS key support for remote control plane cluster disk encryption.

LabelsEntry

The abstract base class for a message.

MaintenanceEvent

A Maintenance Event is an operation that could cause temporary disruptions to the cluster workloads, including Google-driven or user-initiated cluster upgrades, user-initiated cluster configuration changes that require restarting nodes, etc.

Schedule

Indicates when the maintenance event should be performed.

State

Indicates the maintenance event state.

Type

Indicates the maintenance event type.

ReleaseChannel

The release channel a cluster is subscribed to.

Status

Indicates the status of the cluster.

SurvivabilityConfig

Configuration of the cluster survivability, e.g., for the case when network connectivity is lost.

SystemAddonsConfig

Config that customers are allowed to define for GDCE system add-ons.

Ingress

Config for the Ingress add-on which allows customers to create an Ingress object to manage external access to the servers in a cluster. The add-on consists of istiod and istio-ingress.

ClusterNetworking

Cluster-wide networking configuration.

ClusterUser

A user principal for an RBAC policy.

CreateClusterRequest

Creates a cluster.

CreateNodePoolRequest

Creates a node pool.

CreateVpnConnectionRequest

Creates a VPN connection.

DeleteClusterRequest

Deletes a cluster.

DeleteNodePoolRequest

Deletes a node pool.

DeleteVpnConnectionRequest

Deletes a vpn connection.

Fleet

Fleet related configuration.

Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems.

GenerateAccessTokenRequest

Generates an access token for a cluster.

GenerateAccessTokenResponse

An access token for a cluster.

GenerateOfflineCredentialRequest

Generates an offline credential(offline) for a cluster.

GenerateOfflineCredentialResponse

An offline credential for a cluster.

GetClusterRequest

Gets a cluster.

GetMachineRequest

Gets a machine.

GetNodePoolRequest

Gets a node pool.

GetServerConfigRequest

Gets the server config.

GetVpnConnectionRequest

Gets a VPN connection.

KmsKeyState

Represents the accessibility state of a customer-managed KMS key used for CMEK integration.

ListClustersRequest

Lists clusters in a location.

ListClustersResponse

List of clusters in a location.

ListMachinesRequest

Lists machines in a site.

ListMachinesResponse

List of machines in a site.

ListNodePoolsRequest

Lists node pools in a cluster.

ListNodePoolsResponse

List of node pools in a cluster.

ListVpnConnectionsRequest

Lists VPN connections.

ListVpnConnectionsResponse

List of VPN connections in a location.

LocationMetadata

Metadata for a given google.cloud.location.Location.

AvailableZonesEntry

The abstract base class for a message.

Machine

A Google Distributed Cloud Edge machine capable of acting as a Kubernetes node.

LabelsEntry

The abstract base class for a message.

MaintenancePolicy

Maintenance policy configuration.

MaintenanceWindow

Maintenance window configuration

NodePool

A set of Kubernetes nodes in a cluster with common configuration and specification.

LabelsEntry

The abstract base class for a message.

LocalDiskEncryption

Configuration for CMEK support for edge machine local disk encryption.

NodeConfig

Configuration for each node in the NodePool

LabelsEntry

The abstract base class for a message.

OperationMetadata

Long-running operation metadata for Edge Container API methods.

Quota

Represents quota for Edge Container resources.

RecurringTimeWindow

Represents an arbitrary window of time that recurs.

ServerConfig

Server configuration for supported versions and release channels.

ChannelsEntry

The abstract base class for a message.

TimeWindow

Represents an arbitrary window of time.

UpdateClusterRequest

Updates a cluster.

UpdateNodePoolRequest

Updates a node pool.

UpgradeClusterRequest

Upgrades a cluster.

Schedule

Represents the schedule about when the cluster is going to be upgraded.

Version

Version of a cluster.

VpnConnection

A VPN connection .

BgpRoutingMode

Routing mode.

Details

The created connection details.

CloudRouter

The Cloud Router info.

CloudVpn

The Cloud VPN info.

State

The current connection state.

LabelsEntry

The abstract base class for a message.

VpcProject

Project detail of the VPC network.

ZoneMetadata

A Google Distributed Cloud Edge zone where edge machines are located.

RackType

Type of the rack.

RackTypesEntry

The abstract base class for a message.

Modules

pagers

API documentation for edgecontainer_v1.services.edge_container.pagers module.