Configuration Reference

Version:5.8.1-SNAPSHOT

Micronaut Gcp Common Config Properties

🔗
Table 1. Configuration Properties for GoogleCloudConfiguration
Property Type Description

gcp.project-id

java.lang.String

Returns the Google project ID for the project.

🔗
Table 2. Configuration Properties for GoogleComputeMetadataConfiguration
Property Type Description

micronaut.application.gcp.metadata.enabled

boolean

micronaut.application.gcp.metadata.metadata-url

java.lang.String

micronaut.application.gcp.metadata.project-metadata-url

java.lang.String

micronaut.application.gcp.metadata.read-timeout

java.time.Duration

micronaut.application.gcp.metadata.connect-timeout

java.time.Duration

🔗
Table 3. Configuration Properties for GoogleCredentialsConfiguration
Property Type Description

gcp.credentials.scopes

java.util.List

The scopes to use.

gcp.credentials.location

java.lang.String

The location of the service account credential key file. See <a href="https://cloud.google.com/iam/docs/understanding-service-accounts">Understanding Service Accounts</a> for more information on generating a service account key file.

gcp.credentials.encoded-key

java.lang.String

The Base64 encoded service account key content. This is not recommended except if you need to encode service account key via an environmental variable. For other use cases, configure <pre>location</pre> instead.

gcp.credentials.enabled

boolean

Allows disabling Google credentials configuration. This may be useful in situations where you don’t want to authenticate despite having the Google Cloud SDK configured. Default value is true.

gcp.credentials.use-http-client

boolean

If the HttpClient based transport should be used for retrieving authentication tokens. Default value is true. Note that if HttpClient is not on the classpath, the GCP SDK’s default transport will be used instead.

Micronaut Gcp Http Client Config Properties

🔗
Table 4. Configuration Properties for GoogleAuthServiceConfig
Property Type Description

gcp.http.client.auth.services.*.audience

java.lang.String

Micronaut Gcp Pubsub Config Properties

🔗
Table 5. Configuration Properties for PubSubConfigurationProperties
Property Type Description

gcp.pubsub.publishing-executor

java.lang.String

The name of the {@link java.util.concurrent.ScheduledExecutorService} to be used by all {@link com.google.cloud.pubsub.v1.Publisher} instances. Defaults to "scheduled".

gcp.pubsub.subscribing-executor

java.lang.String

The name of the {@link java.util.concurrent.ScheduledExecutorService} to be used by all {@link com.google.cloud.pubsub.v1.Subscriber} instances. Defaults to "scheduled".

gcp.pubsub.keep-alive-interval-minutes

int

How often to ping the server to keep the channel alive. Defaults to 5 minutes.

gcp.pubsub.topic-endpoint

java.lang.String

Which endpoint the {@link com.google.cloud.pubsub.v1.Publisher} should publish messages to. Defaults to the global endpoint

gcp.pubsub.nack-on-shutdown

boolean

Whether subscribers should stop processing pending in-memory messages and eagerly nack() during application shutdown. Defaults to false.

🔗
Table 6. Configuration Properties for PublisherConfigurationProperties
Property Type Description

gcp.pubsub.publisher.*.retry.total-timeout

org.threeten.bp.Duration

gcp.pubsub.publisher.*.retry.total-timeout-duration

java.time.Duration

gcp.pubsub.publisher.*.retry.initial-retry-delay

org.threeten.bp.Duration

gcp.pubsub.publisher.*.retry.initial-retry-delay-duration

java.time.Duration

gcp.pubsub.publisher.*.retry.retry-delay-multiplier

double

gcp.pubsub.publisher.*.retry.max-retry-delay

org.threeten.bp.Duration

gcp.pubsub.publisher.*.retry.max-retry-delay-duration

java.time.Duration

gcp.pubsub.publisher.*.retry.max-attempts

int

gcp.pubsub.publisher.*.retry.initial-rpc-timeout

org.threeten.bp.Duration

gcp.pubsub.publisher.*.retry.initial-rpc-timeout-duration

java.time.Duration

gcp.pubsub.publisher.*.retry.rpc-timeout-multiplier

double

gcp.pubsub.publisher.*.retry.max-rpc-timeout

org.threeten.bp.Duration

gcp.pubsub.publisher.*.retry.max-rpc-timeout-duration

java.time.Duration

gcp.pubsub.publisher.*.retry.logical-timeout

org.threeten.bp.Duration

gcp.pubsub.publisher.*.batching.element-count-threshold

java.lang.Long

gcp.pubsub.publisher.*.batching.request-byte-threshold

java.lang.Long

gcp.pubsub.publisher.*.batching.delay-threshold

org.threeten.bp.Duration

gcp.pubsub.publisher.*.batching.delay-threshold-duration

java.time.Duration

gcp.pubsub.publisher.*.batching.is-enabled

java.lang.Boolean

gcp.pubsub.publisher.*.batching.flow-control-settings

com.google.api.gax.batching.FlowControlSettings

gcp.pubsub.publisher.*.flow-control.max-outstanding-element-count

java.lang.Long

gcp.pubsub.publisher.*.flow-control.max-outstanding-request-bytes

java.lang.Long

gcp.pubsub.publisher.*.flow-control.limit-exceeded-behavior

com.google.api.gax.batching.FlowController$LimitExceededBehavior

gcp.pubsub.publisher.*.executor

java.lang.String

🔗
Table 7. Configuration Properties for PubSubPushConfigurationProperties
Property Type Description

gcp.pubsub.push.enabled

boolean

Whether PubSub Push is enabled.

gcp.pubsub.push.path

java.lang.String

The configured path for the PubSub Push HTTP endpoint. Default value "/push"

🔗
Table 8. Configuration Properties for SubscriberConfigurationProperties
Property Type Description

gcp.pubsub.subscriber.*.parallel-pull-count

java.lang.Integer

gcp.pubsub.subscriber.*.max-ack-extension-period

org.threeten.bp.Duration

Set the maximum period a message ack deadline will be extended. Defaults to one hour.

gcp.pubsub.subscriber.*.max-duration-per-ack-extension

org.threeten.bp.Duration

gcp.pubsub.subscriber.*.executor

java.lang.String

gcp.pubsub.subscriber.*.flow-control.max-outstanding-element-count

java.lang.Long

gcp.pubsub.subscriber.*.flow-control.max-outstanding-request-bytes

java.lang.Long

gcp.pubsub.subscriber.*.flow-control.limit-exceeded-behavior

com.google.api.gax.batching.FlowController$LimitExceededBehavior

Micronaut Gcp Secret Manager Config Properties

🔗
Table 9. Configuration Properties for SecretManagerConfigurationProperties
Property Type Description

gcp.secret-manager.custom-configs

java.util.Set

gcp.secret-manager.keys

java.util.Set

gcp.secret-manager.default-config-enabled

boolean

Whether to load the default config files (application, application_${env}, [APPLICATION_NAME], `[APPLICATION_NAME]_${env}). Default value: true.

gcp.secret-manager.location

java.lang.String

Specifies the location of the regional secrets used to create a {@link com.google.cloud.secretmanager.v1.SecretManagerServiceClient} specific to the location endpoint. If not provided, the client will be created using the global endpoint. It must be one of the available location for the regional endpoints. See <a href="https://cloud.google.com/secret-manager/docs/locations">Secret Manager locations</a> for more information.