package google.cloud.gkehub.v1beta

Get desktop application:
View/edit binary Protocol Buffers messages

The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters. The GKE Hub service operates on the following resources: * [Membership][google.cloud.gkehub.v1beta.Membership] * [Feature][google.cloud.gkehub.v1beta.Feature] GKE Hub is currently only available in the global region. **Membership management may be non-trivial:** it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

• rpc ListFeatures (ListFeaturesRequest, ListFeaturesResponse)

  service.proto:54

  Lists Features in a given project and location.

  message ListFeaturesRequest

  service.proto:109

  Request message for `GkeHub.ListFeatures` method.

  • string parent = 1

    The parent (project and location) where the Features will be listed. Specified in the format `projects/*/locations/*`.

  • int32 page_size = 2

    When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

  • string page_token = 3

    Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources.

  • string filter = 4

    Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name "servicemesh" in project "foo-proj": name = "projects/foo-proj/locations/global/features/servicemesh" - Features that have a label called `foo`: labels.foo:* - Features that have a label called `foo` whose value is `bar`: labels.foo = bar

  • string order_by = 5

    One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

  message ListFeaturesResponse

  service.proto:148

  Response message for the `GkeHub.ListFeatures` method.

  • repeated Feature resources = 1

    The list of matching Features

  • string next_page_token = 2

    A token to request the next page of resources from the `ListFeatures` method. The value of an empty string means that there are no more resources to return.

• rpc GetFeature (GetFeatureRequest, Feature)

  service.proto:62

  Gets details of a single Feature.

  message GetFeatureRequest

  service.proto:159

  Request message for `GkeHub.GetFeature` method.

  • string name = 1

    The Feature resource name in the format `projects/*/locations/*/features/*`

• rpc CreateFeature (CreateFeatureRequest, longrunning.Operation)

  service.proto:70

  Adds a new Feature.

  message CreateFeatureRequest

  service.proto:166

  Request message for the `GkeHub.CreateFeature` method.

  • string parent = 1

    The parent (project and location) where the Feature will be created. Specified in the format `projects/*/locations/*`.

  • string feature_id = 2

    The ID of the feature to create.

  • optional Feature resource = 3

    The Feature resource to create.

  • string request_id = 4

    Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

• rpc DeleteFeature (DeleteFeatureRequest, longrunning.Operation)

  service.proto:83

  Removes a Feature.

  message DeleteFeatureRequest

  service.proto:194

  Request message for `GkeHub.DeleteFeature` method.

  • string name = 1

    The Feature resource name in the format `projects/*/locations/*/features/*`.

  • bool force = 2

    If set to true, the delete will ignore any outstanding resources for this Feature (that is, `FeatureState.has_resources` is set to true). These resources will NOT be cleaned up or modified in any way.

  • string request_id = 3

    Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

• rpc UpdateFeature (UpdateFeatureRequest, longrunning.Operation)

  service.proto:95

  Updates an existing Feature.

  message UpdateFeatureRequest

  service.proto:221

  Request message for `GkeHub.UpdateFeature` method.

  • string name = 1

    The Feature resource name in the format `projects/*/locations/*/features/*`.

  • optional protobuf.FieldMask update_mask = 2

    Mask of fields to update.

  • optional Feature resource = 3

    Only fields specified in update_mask are updated. If you specify a field in the update_mask but don't specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It's not possible to update a key's value to the empty string. If you specify the update_mask to be a special path "*", fully replaces all user-modifiable fields to match `resource`.

  • string request_id = 4

    Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CommonFeatureSpec contains Hub-wide configuration information

Used in: Feature

• oneof feature_spec

  • multiclusteringress.v1beta.FeatureSpec multiclusteringress = 102

    Multicluster Ingress-specific spec.

CommonFeatureState contains Hub-wide Feature status information.

Used in: Feature

• optional FeatureState state = 1

  Output only. The "running state" of the Feature in this Hub.

Feature represents the settings and status of any Hub Feature.

Used as response type in: GkeHub.GetFeature

Used as field type in: CreateFeatureRequest, ListFeaturesResponse, UpdateFeatureRequest

• string name = 1

  Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.

• map<string, string> labels = 2

  Labels for this Feature.

• optional FeatureResourceState resource_state = 3

  Output only. State of the Feature resource itself.

• optional CommonFeatureSpec spec = 4

  Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.

• map<string, MembershipFeatureSpec> membership_specs = 5

  Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.

• optional CommonFeatureState state = 6

  Output only. The Hub-wide Feature state.

• map<string, MembershipFeatureState> membership_states = 7

  Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.

• optional protobuf.Timestamp create_time = 8

  Output only. When the Feature resource was created.

• optional protobuf.Timestamp update_time = 9

  Output only. When the Feature resource was last updated.

• optional protobuf.Timestamp delete_time = 10

  Output only. When the Feature resource was deleted.

FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships.

Used in: Feature

• FeatureResourceState.State state = 1

  The current state of the Feature resource in the Hub API.

State describes the lifecycle status of a Feature.

Used in: FeatureResourceState

• STATE_UNSPECIFIED = 0

  State is unknown or not set.

• ENABLING = 1

  The Feature is being enabled, and the Feature resource is being created. Once complete, the corresponding Feature will be enabled in this Hub.

• ACTIVE = 2

  The Feature is enabled in this Hub, and the Feature resource is fully available.

• DISABLING = 3

  The Feature is being disabled in this Hub, and the Feature resource is being deleted.

• UPDATING = 4

  The Feature resource is being updated.

• SERVICE_UPDATING = 5

  The Feature resource is being updated by the Hub Service.

FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context.

Used in: CommonFeatureState, MembershipFeatureState

• FeatureState.Code code = 1

  The high-level, machine-readable status of this Feature.

• string description = 2

  A human-readable description of the current status.

• optional protobuf.Timestamp update_time = 3

  The time this status and any related Feature-specific details were updated.

Code represents a machine-readable, high-level status of the Feature.

Used in: FeatureState

• CODE_UNSPECIFIED = 0

  Unknown or not set.

• OK = 1

  The Feature is operating normally.

• WARNING = 2

  The Feature has encountered an issue, and is operating in a degraded state. The Feature may need intervention to return to normal operation. See the description and any associated Feature-specific details for more information.

• ERROR = 3

  The Feature is not operating or is in a severely degraded state. The Feature may need intervention to return to normal operation. See the description and any associated Feature-specific details for more information.

MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name.

Used in: Feature

• oneof feature_spec

  • configmanagement.v1beta.MembershipSpec configmanagement = 106

    Config Management-specific spec.

  • servicemesh.v1beta.MembershipSpec mesh = 116

    Anthos Service Mesh-specific spec

  • policycontroller.v1beta.MembershipSpec policycontroller = 118

    Policy Controller spec.

MembershipFeatureState contains Feature status information for a single Membership.

Used in: Feature

• oneof feature_state

  • servicemesh.v1beta.MembershipState servicemesh = 100

    Service Mesh-specific state.

  • metering.v1beta.MembershipState metering = 104

    Metering-specific state.

  • configmanagement.v1beta.MembershipState configmanagement = 106

    Config Management-specific state.

  • policycontroller.v1beta.MembershipState policycontroller = 116

    Policycontroller-specific state.

• optional FeatureState state = 1

  The high-level state of this Feature for a single membership.

Represents the metadata of the long-running operation.

• optional protobuf.Timestamp create_time = 1

  Output only. The time the operation was created.

• optional protobuf.Timestamp end_time = 2

  Output only. The time the operation finished running.

• string target = 3

  Output only. Server-defined resource path for the target of the operation.

• string verb = 4

  Output only. Name of the verb executed by the operation.

• string status_detail = 5

  Output only. Human-readable status of the operation, if any.

• bool cancel_requested = 6

  Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.

• string api_version = 7

  Output only. API version used to start the operation.