Micronaut GCP Configuration Reference

Every documented configuration property of Micronaut GCP, with types, descriptions, and defaults.

Micronaut GCP documentation

60 properties across 4 sections

Micronaut Gcp Common Config Properties

Configuration properties for GoogleCloudConfiguration

PropertyTypeDescription
gcp.project-idjava.lang.StringSets the project id to use.

Configuration properties for GoogleCredentialsConfiguration

PropertyTypeDescription
gcp.credentials.scopesjava.util.ListThe default scopes to associate with the application to access specific APIs. See <a href="https://developers.google.com/identity/protocols/googlescopes">Google Scopes</a> for a complete list. Leave this empty if you don’t need additional API access.
gcp.credentials.locationjava.lang.StringSets the location to the service account credential key file.
gcp.credentials.encoded-keyjava.lang.StringSets the Base64 encoded service account key content..
gcp.credentials.enabledbooleanAllows 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-clientbooleanAllows disabling use of the {@link HttpClient} based transport for retrieving authentication tokens. Default value is true.

Configuration properties for GoogleComputeMetadataConfiguration

PropertyTypeDescription
micronaut.application.gcp.metadata.enabledbooleanDefault value (true).
micronaut.application.gcp.metadata.metadata-urljava.lang.StringDefault value ("http://metadata.google.internal/computeMetadata/v1/project/").
micronaut.application.gcp.metadata.project-metadata-urljava.lang.StringDefault value ("http://metadata.google.internal/project/v1/project/").
micronaut.application.gcp.metadata.read-timeoutjava.time.DurationDefault value (5 seconds).
micronaut.application.gcp.metadata.connect-timeoutjava.time.DurationDefault value (2).

Micronaut Gcp Http Client Config Properties

Configuration properties for GoogleAuthServiceConfig

PropertyTypeDescription
gcp.http.client.auth.services.*.audiencejava.lang.Stringthe desired audience

Micronaut Gcp Pubsub Config Properties

Configuration properties for PubSubConfigurationProperties

PropertyTypeDescription
gcp.pubsub.publishing-executorjava.lang.Stringthe name of the publishing executor
gcp.pubsub.subscribing-executorjava.lang.Stringthe name of the subscribing executor
gcp.pubsub.keep-alive-interval-minutesintHow often to ping the server to keep the channel alive. Default: 5 minutes.
gcp.pubsub.topic-endpointjava.lang.Stringendpoint
gcp.pubsub.nack-on-shutdownbooleannack on shutdown configuration

Configuration properties for PublisherConfigurationProperties

PropertyTypeDescription
gcp.pubsub.publisher.*.executorjava.lang.Stringexecutor name

Configuration properties for BatchingSettings$Builder

PropertyTypeDescription
gcp.pubsub.publisher.*.batching.element-count-thresholdjava.lang.Long
gcp.pubsub.publisher.*.batching.request-byte-thresholdjava.lang.Long
gcp.pubsub.publisher.*.batching.delay-thresholdorg.threeten.bp.Duration
gcp.pubsub.publisher.*.batching.delay-threshold-durationjava.time.Duration
gcp.pubsub.publisher.*.batching.is-enabledjava.lang.Boolean
gcp.pubsub.publisher.*.batching.flow-control-settingscom.google.api.gax.batching.FlowControlSettings

Configuration properties for FlowControlSettings$Builder

PropertyTypeDescription
gcp.pubsub.subscriber.*.flow-control.max-outstanding-element-countjava.lang.Long
gcp.pubsub.subscriber.*.flow-control.max-outstanding-request-bytesjava.lang.Long
gcp.pubsub.subscriber.*.flow-control.limit-exceeded-behaviorcom.google.api.gax.batching.FlowController$LimitExceededBehavior
gcp.pubsub.publisher.*.flow-control.max-outstanding-element-countjava.lang.Long
gcp.pubsub.publisher.*.flow-control.max-outstanding-request-bytesjava.lang.Long
gcp.pubsub.publisher.*.flow-control.limit-exceeded-behaviorcom.google.api.gax.batching.FlowController$LimitExceededBehavior

Configuration properties for RetrySettings$Builder

PropertyTypeDescription
gcp.pubsub.publisher.*.retry.total-timeoutorg.threeten.bp.Duration
gcp.pubsub.publisher.*.retry.total-timeout-durationjava.time.Duration
gcp.pubsub.publisher.*.retry.initial-retry-delayorg.threeten.bp.Duration
gcp.pubsub.publisher.*.retry.initial-retry-delay-durationjava.time.Duration
gcp.pubsub.publisher.*.retry.retry-delay-multiplierdouble
gcp.pubsub.publisher.*.retry.max-retry-delayorg.threeten.bp.Duration
gcp.pubsub.publisher.*.retry.max-retry-delay-durationjava.time.Duration
gcp.pubsub.publisher.*.retry.max-attemptsint
gcp.pubsub.publisher.*.retry.initial-rpc-timeoutorg.threeten.bp.Duration
gcp.pubsub.publisher.*.retry.initial-rpc-timeout-durationjava.time.Duration
gcp.pubsub.publisher.*.retry.rpc-timeout-multiplierdouble
gcp.pubsub.publisher.*.retry.max-rpc-timeoutorg.threeten.bp.Duration
gcp.pubsub.publisher.*.retry.max-rpc-timeout-durationjava.time.Duration
gcp.pubsub.publisher.*.retry.logical-timeoutorg.threeten.bp.Duration

Configuration properties for PubSubPushConfigurationProperties

PropertyTypeDescription
gcp.pubsub.push.enabledbooleanEnables {@link PushController}. Default value true
gcp.pubsub.push.pathjava.lang.StringConfigures the path to the {@link PushController}. Default value "/push"

Configuration properties for SubscriberConfigurationProperties

PropertyTypeDescription
gcp.pubsub.subscriber.*.parallel-pull-countjava.lang.Integernumber of concurrent pulls
gcp.pubsub.subscriber.*.max-ack-extension-periodorg.threeten.bp.DurationSet the maximum period a message ack deadline will be extended. Defaults to one hour.
gcp.pubsub.subscriber.*.max-duration-per-ack-extensionorg.threeten.bp.DurationSet the upper bound for a single mod ack extention period. <p>The ack deadline will continue to be extended by up to this duration until MaxAckExtensionPeriod is reached. Setting MaxDurationPerAckExtension bounds the maximum amount of time before a mesage re-delivery in the event the Subscriber fails to extend the deadline. <p>MaxDurationPerAckExtension configuration can be disabled by specifying a zero duration.
gcp.pubsub.subscriber.*.executorjava.lang.Stringexecutor name

Configuration properties for FlowControlSettings$Builder

PropertyTypeDescription
gcp.pubsub.subscriber.*.flow-control.max-outstanding-element-countjava.lang.Long
gcp.pubsub.subscriber.*.flow-control.max-outstanding-request-bytesjava.lang.Long
gcp.pubsub.subscriber.*.flow-control.limit-exceeded-behaviorcom.google.api.gax.batching.FlowController$LimitExceededBehavior
gcp.pubsub.publisher.*.flow-control.max-outstanding-element-countjava.lang.Long
gcp.pubsub.publisher.*.flow-control.max-outstanding-request-bytesjava.lang.Long
gcp.pubsub.publisher.*.flow-control.limit-exceeded-behaviorcom.google.api.gax.batching.FlowController$LimitExceededBehavior

Micronaut Gcp Secret Manager Config Properties

Configuration properties for SecretManagerConfigurationProperties

PropertyTypeDescription
gcp.secret-manager.custom-configsjava.util.SetCustom config files to be included as property sources.
gcp.secret-manager.keysjava.util.SetSet of secrets to be loaded
gcp.secret-manager.default-config-enabledbooleanWhether to load the default config files.
gcp.secret-manager.locationjava.lang.StringLocation of the regional secrets