Class Plugin.ConfigTemplate.AuthConfigTemplate.Builder (0.28.0)

public static final class Plugin.ConfigTemplate.AuthConfigTemplate.Builder extends GeneratedMessageV3.Builder<Plugin.ConfigTemplate.AuthConfigTemplate.Builder> implements Plugin.ConfigTemplate.AuthConfigTemplateOrBuilder

AuthConfigTemplate represents the authentication template for a plugin.

Protobuf type google.cloud.apihub.v1.Plugin.ConfigTemplate.AuthConfigTemplate

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllSupportedAuthTypes(Iterable<? extends AuthType> values)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder addAllSupportedAuthTypes(Iterable<? extends AuthType> values)

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
values Iterable<? extends com.google.cloud.apihub.v1.AuthType>

The supportedAuthTypes to add.

Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

This builder for chaining.

addAllSupportedAuthTypesValue(Iterable<Integer> values)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder addAllSupportedAuthTypesValue(Iterable<Integer> values)

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
values Iterable<Integer>

The enum numeric values on the wire for supportedAuthTypes to add.

Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides

addSupportedAuthTypes(AuthType value)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder addSupportedAuthTypes(AuthType value)

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
value AuthType

The supportedAuthTypes to add.

Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

This builder for chaining.

addSupportedAuthTypesValue(int value)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder addSupportedAuthTypesValue(int value)

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
value int

The enum numeric value on the wire for supportedAuthTypes to add.

Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

This builder for chaining.

build()

public Plugin.ConfigTemplate.AuthConfigTemplate build()
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate

buildPartial()

public Plugin.ConfigTemplate.AuthConfigTemplate buildPartial()
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate

clear()

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder clear()
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides

clearServiceAccount()

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder clearServiceAccount()

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
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

clearSupportedAuthTypes()

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder clearSupportedAuthTypes()

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
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

This builder for chaining.

clone()

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder clone()
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides

getDefaultInstanceForType()

public Plugin.ConfigTemplate.AuthConfigTemplate getDefaultInstanceForType()
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getServiceAccount()

public 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.

getServiceAccountBuilder()

public GoogleServiceAccountConfig.Builder getServiceAccountBuilder()

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.Builder

getServiceAccountOrBuilder()

public 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 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Plugin.ConfigTemplate.AuthConfigTemplate other)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder mergeFrom(Plugin.ConfigTemplate.AuthConfigTemplate other)
Parameter
Name Description
other Plugin.ConfigTemplate.AuthConfigTemplate
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides

mergeServiceAccount(GoogleServiceAccountConfig value)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder mergeServiceAccount(GoogleServiceAccountConfig value)

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];

Parameter
Name Description
value GoogleServiceAccountConfig
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Plugin.ConfigTemplate.AuthConfigTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides

setServiceAccount(GoogleServiceAccountConfig value)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder setServiceAccount(GoogleServiceAccountConfig value)

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];

Parameter
Name Description
value GoogleServiceAccountConfig
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

setServiceAccount(GoogleServiceAccountConfig.Builder builderForValue)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder setServiceAccount(GoogleServiceAccountConfig.Builder builderForValue)

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];

Parameter
Name Description
builderForValue GoogleServiceAccountConfig.Builder
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

setSupportedAuthTypes(int index, AuthType value)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder setSupportedAuthTypes(int index, AuthType value)

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];

Parameters
Name Description
index int

The index to set the value at.

value AuthType

The supportedAuthTypes to set.

Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

This builder for chaining.

setSupportedAuthTypesValue(int index, int value)

public Plugin.ConfigTemplate.AuthConfigTemplate.Builder setSupportedAuthTypesValue(int index, int value)

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];

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for supportedAuthTypes to set.

Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Plugin.ConfigTemplate.AuthConfigTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Plugin.ConfigTemplate.AuthConfigTemplate.Builder
Overrides