# Package google.cloud.edgecontainer.v1main

## Index

- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ConfigData` (message)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.IdentityProvider` (message)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.LocationMetadata` (message)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.OIDCProviderConfig` (message)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.OperationMetadata` (message)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.OperationMetadata.StatusReason` (enum)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.Quota` (message)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.SAMLProviderConfig` (message)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ServiceAccount` (message)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ServiceAccount.State` (enum)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ZonalService` (message)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ZonalService.ServiceSelector` (enum)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ZonalService.State` (enum)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ZoneMetadata` (message)
- `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ZoneMetadata.RackType` (enum)

## ConfigData

Config data holds all the config related data for the zone.

| Fields ||
|---|---|
| `available_external_lb_pools_ipv4[]` | `string` list of available v4 ip pools for external loadbalancer |
| `available_external_lb_pools_ipv6[]` | `string` list of available v6 ip pools for external loadbalancer |

## IdentityProvider

Represents an identity provider resource which represents the identity provider configuration for the organization.

| Fields ||
|---|---|
| `name` | `string` Identifier. The canonical resource name of the identity provider. E.g. organizations/{organization}/locations/{location}/identityProviders/{identity_provider} |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the identity provider was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the identity provider was last updated. |
| `delete_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the identity provider was deleted. |
| `labels` | `map<string, string>` Optional. Labels associated with this resource. |
| Union field `config`. The configuration of the identity provider. `config` can be only one of the following: ||
| `oidc_config` | `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.OIDCProviderConfig` The OIDC provider configuration. |
| `saml_config` | `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.SAMLProviderConfig` The SAML provider configuration. |
| Union field `target`. The target of the identity provider. `target` can be only one of the following: ||
| `zone_id` | `string` The zone id of the target zone of the infra cluster for which the identity provider is to be configured. |
| `cluster` | `string` The fully qualified name of the target BMUC for which the identity provider is to be configured. |

## LocationMetadata

Metadata for a given `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.location#google.cloud.location.Location`.

| Fields ||
|---|---|
| `available_zones` | ``map<string, `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ZoneMetadata`>`` The set of available Google Distributed Cloud Edge zones in the location. The map is keyed by the lowercase ID of each zone. |

## OIDCProviderConfig

Represents the OIDC provider configuration.

| Fields ||
|---|---|
| `client_id` | `string` Required. The client id of the identity provider. |
| `client_secret` | `string` Optional. The client secret of the identity provider. |
| `issuer_uri` | `string` Required. The issuer uri of the identity provider. |
| `scopes` | `string` Required. The scopes of the identity provider. |
| `user_claim` | `string` Optional. The user claim of the identity provider. |
| `extra_params` | `string` Optional. Comma-separated list of key-value pairs that will be query-encoded and sent with the authentication endpoint request. |
| `certificate_authority_data` | `string` Optional. The certificate authority data of the identity provider. |
| `group_claim` | `string` Optional. The group claim of the identity provider. |
| `attribute_mapping` | `map<string, string>` Optional. The attribute mapping of the identity provider. |

## OperationMetadata

Long-running operation metadata for Edge Container API methods.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The time the operation was created. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The time the operation finished running. |
| `target` | `string` Server-defined resource path for the target of the operation. |
| `verb` | `string` The verb executed by the operation. |
| `status_message` | `string` Human-readable status of the operation, if any. |
| `requested_cancellation` | `bool` Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have \[Operation.error\]\[\] value with a `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.rpc#google.rpc.Status.FIELDS.int32.google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`. |
| `api_version` | `string` API version used to start the operation. |
| `warnings[]` | `string` Warnings that do not block the operation, but still hold relevant information for the end user to receive. |
| `status_reason` | `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.OperationMetadata.StatusReason` Machine-readable status of the operation, if any. |

## StatusReason

Indicates the reason for the status of the operation.

| Enums ||
|---|---|
| `STATUS_REASON_UNSPECIFIED` | Reason unknown. |
| `UPGRADE_PAUSED` | The cluster upgrade is currently paused. |
| `RETRYABLE_ERROR` | The request has errored, but the error is retryable. |

## Quota

Represents quota for Edge Container resources.

| Fields ||
|---|---|
| `metric` | `string` Name of the quota metric. |
| `limit` | `double` Quota limit for this metric. |
| `usage` | `double` Current usage of this metric. |

## SAMLProviderConfig

Represents the SAML provider configuration.

| Fields ||
|---|---|
| `entity_id` | `string` Required. The entity id of the identity provider. |
| `single_sign_on_uri` | `string` Required. The single sign on uri of the identity provider. |
| `certificate_data[]` | `string` Optional. The certificate data of the identity provider. |
| `user_attribute` | `string` Optional. The user attribute of the identity provider. |
| `group_attribute` | `string` Optional. The group attribute of the identity provider. |
| `attribute_mapping` | `map<string, string>` Optional. The attribute mapping of the identity provider. |

## ServiceAccount

Represents the service account resource.

| Fields ||
|---|---|
| `name` | `string` Identifier. The canonical resource name of the project service account. E.g. projects/{project}/locations/{location}/serviceAccounts/{service_account} |
| `zone` | `string` Required. The zone id of the zone on which the project service account has to be created. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the project service account was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the project service account was last updated. |
| `labels` | `map<string, string>` Optional. Labels associated with this resource. |
| `state` | `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ServiceAccount.State` Output only. The state of the service account. |

## State

The state of the service account.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unspecified. |
| `CREATING` | The service account is in CREATING state. |
| `RUNNING` | The service account is in RUNNING state. |
| `DELETING` | The service account is in DELETING state. |
| `ERROR` | The service account is in ERROR state. |
| `REPAIRING` | The service account is in REPAIRING state. |

## ZonalService

Service enabled on the project.

| Fields ||
|---|---|
| `name` | `string` Identifier. The resource name of the service. |
| `service_selector` | `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ZonalService.ServiceSelector` Optional. The service to enable/disable. Only one of service_selector or service_name must be specified. |
| `state` | `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ZonalService.State` Output only. The state of the service. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the service was enabled. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the service was last updated. |
| `labels` | `map<string, string>` Optional. Labels associated with this resource. |
| Union field `zone_or_cluster`. The zone or cluster on which the service has to be enabled/disabled. `zone_or_cluster` can be only one of the following: ||
| `zone` | `string` The zone id of the zone on which the service has to be enabled/disabled. |
| `cluster` | `string` The fully qualified name of the cluster on which the service has to be enabled/disabled. |
| `service_name` | `string` Optional. The full service name, e.g.: alloydb.googleapis.com. Only one of service_selector or service_name must be specified. It will be used to enable/disable the service on the project. |

## ServiceSelector

Services that can be enabled/disabled.

| Enums ||
|---|---|
| `SERVICE_SELECTOR_UNSPECIFIED` | Unspecified. |
| `ALLOYDB` | AlloyDB service, alloydb.googleapis.com. |
| `VMM` | VMM service, gdcvmmanager.googleapis.com. |
| `BOOKSTORE` | Bookstore service, bookstore.googleapis.com. |
| `VERTEX` | Vertex service, aiplatform.googleapis.com. |
| `BOOKSTORE_AI` | Bookstore.AI service, bookstore-ai.googleapis.com. |

## State

The state of the service.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unspecified. |
| `STATE_ENABLED` | The service is enabled on the project. |
| `STATE_DISABLED` | The service is disabled on the project. |
| `STATE_ENABLING` | The service is being enabled on the project. |
| `STATE_DISABLING` | The service is being disabled on the project. |
| `STATE_REPAIRING` | The service is being repaired. |

## ZoneMetadata

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

| Fields ||
|---|---|
| `quota[]` | `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.Quota` Quota for resources in this zone. |
| `rack_types` | ``map<string, `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ZoneMetadata.RackType`>`` The map keyed by rack name and has value of RackType. |
| `config_data` | `https://docs.cloud.google.com/distributed-cloud/connected/1.12.0/docs/reference/container/rpc/google.cloud.edgecontainer.v1main#google.cloud.edgecontainer.v1main.ConfigData` Config data for the zone. |

## RackType

Type of the rack.

| Enums ||
|---|---|
| `RACK_TYPE_UNSPECIFIED` | Unspecified rack type, single rack also belongs to this type. |
| `BASE` | Base rack type, a pair of two modified Config-1 racks containing Aggregation switches. |
| `EXPANSION` | Expansion rack type, also known as standalone racks, added by customers on demand. |