Interface Plugin.ConfigTemplate.AuthConfigTemplateOrBuilder (0.28.0)

Version latest

• 0.28.0 (latest)
• 0.27.0
• 0.26.0
• 0.25.0
• 0.23.0
• 0.21.0
• 0.20.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.2.0
• 0.1.0

public static interface Plugin.ConfigTemplate.AuthConfigTemplateOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getServiceAccount()

public abstract GoogleServiceAccountConfig getServiceAccount()

Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin.

For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.

.google.cloud.apihub.v1.GoogleServiceAccountConfig service_account = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GoogleServiceAccountConfig	The serviceAccount.

getServiceAccountOrBuilder()

public abstract GoogleServiceAccountConfigOrBuilder getServiceAccountOrBuilder()

Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin.

For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.

.google.cloud.apihub.v1.GoogleServiceAccountConfig service_account = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GoogleServiceAccountConfigOrBuilder

getSupportedAuthTypes(int index)

public abstract AuthType getSupportedAuthTypes(int index)

Required. The list of authentication types supported by the plugin.

repeated .google.cloud.apihub.v1.AuthType supported_auth_types = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
AuthType	The supportedAuthTypes at the given index.

getSupportedAuthTypesCount()

public abstract int getSupportedAuthTypesCount()

Required. The list of authentication types supported by the plugin.

repeated .google.cloud.apihub.v1.AuthType supported_auth_types = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The count of supportedAuthTypes.

getSupportedAuthTypesList()

public abstract List<AuthType> getSupportedAuthTypesList()

Required. The list of authentication types supported by the plugin.

repeated .google.cloud.apihub.v1.AuthType supported_auth_types = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<AuthType>	A list containing the supportedAuthTypes.

getSupportedAuthTypesValue(int index)

public abstract int getSupportedAuthTypesValue(int index)

Required. The list of authentication types supported by the plugin.

repeated .google.cloud.apihub.v1.AuthType supported_auth_types = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
int	The enum numeric value on the wire of supportedAuthTypes at the given index.

getSupportedAuthTypesValueList()

public abstract List<Integer> getSupportedAuthTypesValueList()

Required. The list of authentication types supported by the plugin.

repeated .google.cloud.apihub.v1.AuthType supported_auth_types = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for supportedAuthTypes.

hasServiceAccount()

public abstract boolean hasServiceAccount()

Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin.

For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.

.google.cloud.apihub.v1.GoogleServiceAccountConfig service_account = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the serviceAccount field is set.