Package google.cloud.gkehub.v2alpha

Index

GkeHubFeature (interface)
CreateMembershipFeatureRequest (message)
DeleteMembershipFeatureRequest (message)
FeatureConfigRef (message)
FeatureSpec (message)
FeatureSpec.Origin (message)
FeatureSpec.Origin.Type (enum)
FeatureState (message)
GetMembershipFeatureRequest (message)
LifecycleState (message)
LifecycleState.State (enum)
ListMembershipFeaturesRequest (message)
ListMembershipFeaturesResponse (message)
MembershipFeature (message)
OperationMetadata (message)
State (message)
State.Code (enum)
UpdateMembershipFeatureRequest (message)

GkeHubFeature

v2main-based GkeHubFeature provides the following services: 1) Management of MembershipFeature resources. 2) Management of FeatureConfig resources.

CreateMembershipFeature

CreateMembershipFeature
`rpc CreateMembershipFeature(CreateMembershipFeatureRequest) returns (Operation)` Creates membershipFeature under a given parent. Authorization scopes Requires the following OAuth scope: `https://www.googleapis.com/auth/cloud-platform` For more information, see the Authentication Overview.

rpc CreateMembershipFeature(CreateMembershipFeatureRequest) returns (Operation)

Creates membershipFeature under a given parent.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteMembershipFeature

DeleteMembershipFeature
`rpc DeleteMembershipFeature(DeleteMembershipFeatureRequest) returns (Operation)` Removes a membershipFeature. Authorization scopes Requires the following OAuth scope: `https://www.googleapis.com/auth/cloud-platform` For more information, see the Authentication Overview.

rpc DeleteMembershipFeature(DeleteMembershipFeatureRequest) returns (Operation)

Removes a membershipFeature.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetMembershipFeature

GetMembershipFeature
`rpc GetMembershipFeature(GetMembershipFeatureRequest) returns (MembershipFeature)` ========= MembershipFeature Services ========= Gets details of a membershipFeature. Authorization scopes Requires the following OAuth scope: `https://www.googleapis.com/auth/cloud-platform` For more information, see the Authentication Overview.

rpc GetMembershipFeature(GetMembershipFeatureRequest) returns (MembershipFeature)

========= MembershipFeature Services ========= Gets details of a membershipFeature.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListMembershipFeatures

ListMembershipFeatures
`rpc ListMembershipFeatures(ListMembershipFeaturesRequest) returns (ListMembershipFeaturesResponse)` Lists MembershipFeatures in a given project and location. Authorization scopes Requires the following OAuth scope: `https://www.googleapis.com/auth/cloud-platform` For more information, see the Authentication Overview.

rpc ListMembershipFeatures(ListMembershipFeaturesRequest) returns (ListMembershipFeaturesResponse)

Lists MembershipFeatures in a given project and location.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateMembershipFeature

UpdateMembershipFeature
`rpc UpdateMembershipFeature(UpdateMembershipFeatureRequest) returns (Operation)` Updates an existing MembershipFeature. Authorization scopes Requires the following OAuth scope: `https://www.googleapis.com/auth/cloud-platform` For more information, see the Authentication Overview.

rpc UpdateMembershipFeature(UpdateMembershipFeatureRequest) returns (Operation)

Updates an existing MembershipFeature.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateMembershipFeatureRequest

Response message for the GkeHubFeature.CreateMembershipFeature method.

Fields
`parent`	`string` Required. The name of parent where the MembershipFeature will be created. Specified in the format `projects//locations//memberships/*`. Authorization requires the following IAM permission on the specified resource `parent`: `gkehub.membershipfeatures.create`
`membership_feature`	`MembershipFeature` Required. The MembershipFeature to create.
`request_id`	`string` Idempotent request UUID.
`feature_id`	`string` Required. The ID of the membership_feature to create.

DeleteMembershipFeatureRequest

Request message for GkeHubFeature.DeleteMembershipFeatureRequest method.

Fields

Fields
`name`	`string` Required. The name of the membershipFeature to be deleted. Specified in the format `projects//locations//memberships//features/`. Authorization requires the following IAM permission on the specified resource `name`: `gkehub.membershipfeatures.delete`
`request_id`	`string` Idempotent request UUID.

name

string

Required. The name of the membershipFeature to be deleted. Specified in the format projects/*/locations/*/memberships/*/features/*.

Authorization requires the following IAM permission on the specified resource name:

gkehub.membershipfeatures.delete

request_id

string

Idempotent request UUID.

FeatureConfigRef

Information of the FeatureConfig applied on the MembershipFeature.

Fields

Fields
`config`	`string` Input only. Resource name of FeatureConfig, in the format: `projects/{project}/locations/global/featureConfigs/{feature_config}`.
`uuid`	`string` Output only. An id that uniquely identify a FeatureConfig object.
`config_update_time`	`Timestamp` Output only. When the FeatureConfig was last applied and copied to FeatureSpec.

config

string

Input only. Resource name of FeatureConfig, in the format: projects/{project}/locations/global/featureConfigs/{feature_config}.

uuid

string

Output only. An id that uniquely identify a FeatureConfig object.

config_update_time

Timestamp

Output only. When the FeatureConfig was last applied and copied to FeatureSpec.

FeatureSpec

FeatureSpec contains user input per-feature spec information.

Fields
`origin`	`FeatureSpec.Origin` Whether this per-Feature spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Feature config (updated to USER implicitly) or setting to FLEET explicitly.
Union field `feature_spec`. Spec specific to each Fleet feature. oneof feature type will always match the {feature-type} in the FeatureConfig resource name. `feature_spec` can be only one of the following:
`workloadcertificate`	`Spec` Workloadcertificate-specific FeatureSpec.
`cloudbuild`	`Spec` Cloudbuild-specific FeatureSpec.
`policycontroller`	`Spec` Policycontroller-specific FeatureSpec.
`identityservice`	`Spec` IdentityService FeatureSpec.
`servicemesh`	`Spec` ServiceMesh Feature Spec.
`configmanagement`	`Spec` Config Management FeatureSpec.

Origin

Origin defines where this FeatureSpec originated from.

Fields

Fields
`type`	`FeatureSpec.Origin.Type` Type specifies which type of origin is set.

type

FeatureSpec.Origin.Type

Type specifies which type of origin is set.

Type

Type specifies the persona that persisted the config.

Enums
`TYPE_UNSPECIFIED`	Type is unknown or not set.
`FLEET`	Per-Feature spec was inherited from the fleet-level default.
`FLEET_OUT_OF_SYNC`	Per-Feature spec was inherited from the fleet-level default but is now out of sync with the current default.
`USER`	Per-Feature spec was inherited from a user specification.

FeatureState

FeatureState contains high-level state information and per-feature state information for this MembershipFeature.

Fields
`state`	`State` The high-level state of this MembershipFeature.
Union field `feature_state`. Status specific to each Fleet feature. `feature_state` can be only one of the following:
`clusterupgrade`	`State` Cluster upgrade state.
`identityservice`	`State` Identity service state
`servicemesh`	`State` Service mesh state
`metering`	`State` Metering state
`configmanagement`	`State` Config Management state
`policycontroller`	`State` Policy Controller state
`appdevexperience`	`State` Appdevexperience specific state.

GetMembershipFeatureRequest

Request message for GkeHubFeature.GetMembershipFeature method.

Fields

Fields
`name`	`string` Required. The MembershipFeature resource name in the format `projects//locations//memberships//features/`. Authorization requires the following IAM permission on the specified resource `name`: `gkehub.membershipfeatures.get`

name

string

Required. The MembershipFeature resource name in the format projects/*/locations/*/memberships/*/features/*.

Authorization requires the following IAM permission on the specified resource name:

gkehub.membershipfeatures.get

LifecycleState

LifecycleState describes the state of a MembershipFeature resource in the GkeHub API. See FeatureState for the "running state" of the MembershipFeature.

Fields

Fields
`state`	`LifecycleState.State` Output only. The current state of the Feature resource in the Hub API.

state

LifecycleState.State

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

State

State describes the lifecycle status of a MembershipFeature.

Enums
`STATE_UNSPECIFIED`	State is unknown or not set.
`ENABLING`	The MembershipFeature is being enabled, and the MembershipFeature resource is being created. Once complete, the corresponding MembershipFeature will be enabled in this Hub.
`ACTIVE`	The MembershipFeature is enabled in this Hub, and the MembershipFeature resource is fully available.
`DISABLING`	The MembershipFeature is being disabled in this Hub, and the MembershipFeature resource is being deleted.
`UPDATING`	The MembershipFeature resource is being updated.
`SERVICE_UPDATING`	The MembershipFeature resource is being updated by the Hub Service.

ListMembershipFeaturesRequest

Request message for GkeHubFeature.ListMembershipFeatures method.

Fields
`parent`	`string` Required. The parent where the MembershipFeature will be listed. In the format: `projects//locations//memberships/*`. Authorization requires the following IAM permission on the specified resource `parent`: `gkehub.membershipfeatures.list`
`page_size`	`int32` 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.
`page_token`	`string` Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources.
`filter`	`string` Lists MembershipFeatures that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: Feature with the name "helloworld" in project "foo-proj" and membership "member-bar": `name = "projects/foo-proj/locations/global/memberships/member-bar/features/helloworld"` Features that have a label called `foo`: `labels.foo:*` Features that have a label called `foo` whose value is `bar`: `labels.foo = bar`
`order_by`	`string` One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

ListMembershipFeaturesResponse

Response message for the GkeHubFeature.ListMembershipFeatures method.

Fields

Fields
`membership_features[]`	`MembershipFeature` The list of matching MembershipFeatures.
`next_page_token`	`string` A token to request the next page of resources from the `ListMembershipFeatures` method. The value of an empty string means that there are no more resources to return.
`unreachable[]`	`string` List of locations that could not be reached while fetching this list.

membership_features[]

MembershipFeature

The list of matching MembershipFeatures.

next_page_token

string

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

unreachable[]

string

List of locations that could not be reached while fetching this list.

MembershipFeature

MembershipFeature represents the settings and status of a Fleet Feature enabled on a single Fleet Membership.

Fields
`name`	`string` Output only. The resource name of the membershipFeature, in the format: `projects/{project}/locations/{location}/memberships/{membership}/features/{feature}`. Note that `membershipFeatures` is shortened to `features` in the resource name. (see http://go/aip/122#collection-identifiers)
`labels`	`map<string, string>` GCP labels for this MembershipFeature.
`feature_config_ref`	`FeatureConfigRef` Reference information for a FeatureConfig applied on the MembershipFeature.
`spec`	`FeatureSpec` Spec of this membershipFeature.
`state`	`FeatureState` Output only. State of the this membershipFeature.
`lifecycle_state`	`LifecycleState` Output only. Lifecycle information of the resource itself.
`create_time`	`Timestamp` Output only. When the MembershipFeature resource was created.
`update_time`	`Timestamp` Output only. When the MembershipFeature resource was last updated.
`delete_time`	`Timestamp` Output only. When the MembershipFeature resource was deleted.

OperationMetadata

Metadata of the long-running operation.

Fields
`create_time`	`Timestamp` Output only. The time the operation was created.
`end_time`	`Timestamp` Output only. The time the operation finished running.
`target`	`string` Output only. Server-defined resource path for the target of the operation.
`verb`	`string` Output only. Name of the verb executed by the operation.
`status_detail`	`string` Output only. Human-readable status of the operation, if any.
`cancel_requested`	`bool` 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` of 1, corresponding to `Code.CANCELLED`.
`api_version`	`string` Output only. API version used to start the operation.

State

High-level state of a MembershipFeature.

Fields

Fields
`code`	`State.Code` The high-level, machine-readable status of this MembershipFeature.
`description`	`string` A human-readable description of the current status.
`update_time`	`Timestamp` The time this status and any related Feature-specific details were updated.

code

State.Code

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

description

string

A human-readable description of the current status.

update_time

Timestamp

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

Code

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

Enums
`CODE_UNSPECIFIED`	Unknown or not set.
`OK`	The MembershipFeature is operating normally.
`WARNING`	The MembershipFeature has encountered an issue, and is operating in a degraded state. The MembershipFeature may need intervention to return to normal operation. See the description and any associated MembershipFeature-specific details for more information.
`ERROR`	The MembershipFeature is not operating or is in a severely degraded state. The MembershipFeature may need intervention to return to normal operation. See the description and any associated MembershipFeature-specific details for more information.

UpdateMembershipFeatureRequest

Request message for GkeHubFeature.UpdateMembershipFeature method.

Fields
`update_mask`	`FieldMask` Required. Mask of fields to update.
`membership_feature`	`MembershipFeature` Required. Update description. Only fields specified in update_mask are updated.
`request_id`	`string` Idempotent request UUID.
`allow_missing`	`bool` Optional. If set to true, and the MembershipFeature is not found, a new MembershipFeature will be created. In this situation, `update_mask` is ignored.