From 9068ec1ebf1e7d863235439910ef2600ddff71db Mon Sep 17 00:00:00 2001 From: "renovate[bot]" Date: Thu, 19 Dec 2024 01:05:58 +0000 Subject: [PATCH] Deploying to gh-pages - 01:05:58 --- snapshot/guide/configurationreference.html | 326 ++++++++++----------- 1 file changed, 163 insertions(+), 163 deletions(-) diff --git a/snapshot/guide/configurationreference.html b/snapshot/guide/configurationreference.html index dcd679123..d6cf080b1 100644 --- a/snapshot/guide/configurationreference.html +++ b/snapshot/guide/configurationreference.html @@ -51,60 +51,9 @@

Configuration Reference

Micronaut Gcp Common Config Properties

-🔗 - - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1. Configuration Properties for GoogleCredentialsConfiguration
PropertyTypeDescription

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.

-
🔗 - +@@ -146,9 +95,9 @@

Micronaut Gcp Common Config Pro

Table 2. Configuration Properties for GoogleComputeMetadataConfigurationTable 1. Configuration Properties for GoogleComputeMetadataConfiguration
-🔗 +🔗 - +@@ -163,90 +112,43 @@

Micronaut Gcp Common Config Pro

- - - - - -
Table 3. Configuration Properties for GoogleCloudConfigurationTable 2. Configuration Properties for GoogleCredentialsConfiguration

gcp.project-id

java.lang.String

Returns the Google project ID for the project.

-
-
-
-

Micronaut Gcp Http Client Config Properties

-🔗 - - ----- - - - - - - - - - - - - - - -
Table 4. Configuration Properties for GoogleAuthServiceConfig
PropertyTypeDescription

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

java.lang.String

-
-
-
-

Micronaut Gcp Pubsub Config Properties

-🔗 - - ----- - - - - - + + + - - - + - + - + - - - - - - + - - - + + + - + - +
Table 5. Configuration Properties for PubSubConfigurationProperties
PropertyTypeDescription

gcp.credentials.scopes

java.util.List

The scopes to use.

gcp.pubsub.publishing-executor

gcp.credentials.location

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

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.pubsub.subscribing-executor

gcp.credentials.encoded-key

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.

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.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.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.pubsub.nack-on-shutdown

gcp.credentials.use-http-client

boolean

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

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.
-🔗 +🔗 - +@@ -261,21 +163,19 @@

Micronaut Gcp Pubsub Config Pro

- - - - - - + - +
Table 6. Configuration Properties for PubSubPushConfigurationPropertiesTable 3. Configuration Properties for GoogleCloudConfiguration

gcp.pubsub.push.enabled

boolean

Whether PubSub Push is enabled.

gcp.pubsub.push.path

gcp.project-id

java.lang.String

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

Returns the Google project ID for the project.
-🔗 +
+
+

Micronaut Gcp Http Client Config Properties

+🔗 - +@@ -290,46 +190,19 @@

Micronaut Gcp Pubsub Config Pro

- - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - -
Table 7. Configuration Properties for SubscriberConfigurationPropertiesTable 4. Configuration Properties for GoogleAuthServiceConfig

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

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

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 Pubsub Config Properties

🔗 - +@@ -466,6 +339,133 @@

Micronaut Gcp Pubsub Config Pro

Table 8. Configuration Properties for PublisherConfigurationPropertiesTable 5. Configuration Properties for PublisherConfigurationProperties
+🔗 + + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6. Configuration Properties for PubSubConfigurationProperties
PropertyTypeDescription

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 7. Configuration Properties for PubSubPushConfigurationProperties
PropertyTypeDescription

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
PropertyTypeDescription

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