Merge pull request #332 from GoogleCloudPlatform/gh_pages

Update Documentation
GoogleCloudPlatform · Dec 29, 2024 · 823de67 · 823de67
2 parents b1db063 + 748e0eb
commit 823de67
Show file tree

Hide file tree

Showing 101 changed files with 272 additions and 348 deletions.
diff --git a/docs/integrationcli.md b/docs/integrationcli.md
@@ -35,4 +35,4 @@ This command lets you interact with GCP Application Integration and Integration
 * [integrationcli sfdcinstances](integrationcli_sfdcinstances.md)	 - Manage SFDC instances in Application Integration
 * [integrationcli token](integrationcli_token.md)	 - Manage OAuth 2.0 access tokens
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_authconfigs.md b/docs/integrationcli_authconfigs.md
@@ -38,4 +38,4 @@ Manage integration auth configurations
 * [integrationcli authconfigs list](integrationcli_authconfigs_list.md)	 - List all integration flows in the region
 * [integrationcli authconfigs update](integrationcli_authconfigs_update.md)	 - Update an existing authconfig
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_authconfigs_create.md b/docs/integrationcli_authconfigs_create.md
@@ -10,6 +10,15 @@ Create an authconfig
 integrationcli authconfigs create [flags]
 ```
 
+### Examples
+
+```
+Create a new user name auth config: integrationcli authconfigs create -f samples/ac_username.json
+Create a new OIDC auth config: integrationcli authconfigs create -f samples/ac_oidc.json
+Create a new auth token auth config: integrationcli authconfigs create -f samples/ac_authtoken.json
+Create a new auth config from Cloud KMS Encrypted files: integrationcli authconfigs create -e samples/b64encoded_ac.txt -k locations/$region/keyRings/$key/cryptoKeys/$cryptokey
+```
+
 ### Options
 
 ```
@@ -39,4 +48,4 @@ integrationcli authconfigs create [flags]
 
 * [integrationcli authconfigs](integrationcli_authconfigs.md)	 - Manage integration auth configurations
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_authconfigs_delete.md b/docs/integrationcli_authconfigs_delete.md
@@ -37,4 +37,4 @@ integrationcli authconfigs delete [flags]
 
 * [integrationcli authconfigs](integrationcli_authconfigs.md)	 - Manage integration auth configurations
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_authconfigs_export.md b/docs/integrationcli_authconfigs_export.md
@@ -37,4 +37,4 @@ integrationcli authconfigs export [flags]
 
 * [integrationcli authconfigs](integrationcli_authconfigs.md)	 - Manage integration auth configurations
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_authconfigs_get.md b/docs/integrationcli_authconfigs_get.md
@@ -39,4 +39,4 @@ integrationcli authconfigs get [flags]
 
 * [integrationcli authconfigs](integrationcli_authconfigs.md)	 - Manage integration auth configurations
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_authconfigs_list.md b/docs/integrationcli_authconfigs_list.md
@@ -39,4 +39,4 @@ integrationcli authconfigs list [flags]
 
 * [integrationcli authconfigs](integrationcli_authconfigs.md)	 - Manage integration auth configurations
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_authconfigs_update.md b/docs/integrationcli_authconfigs_update.md
@@ -39,4 +39,4 @@ integrationcli authconfigs update [flags]
 
 * [integrationcli authconfigs](integrationcli_authconfigs.md)	 - Manage integration auth configurations
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_certificates.md b/docs/integrationcli_certificates.md
@@ -36,4 +36,4 @@ Manage certificates used by Integration
 * [integrationcli certificates get](integrationcli_certificates_get.md)	 - Get certificate details from a region
 * [integrationcli certificates list](integrationcli_certificates_list.md)	 - List all certificates in the region
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_certificates_create.md b/docs/integrationcli_certificates_create.md
@@ -41,4 +41,4 @@ integrationcli certificates create [flags]
 
 * [integrationcli certificates](integrationcli_certificates.md)	 - Manage certificates used by Integration
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_certificates_delete.md b/docs/integrationcli_certificates_delete.md
@@ -37,4 +37,4 @@ integrationcli certificates delete [flags]
 
 * [integrationcli certificates](integrationcli_certificates.md)	 - Manage certificates used by Integration
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_certificates_get.md b/docs/integrationcli_certificates_get.md
@@ -38,4 +38,4 @@ integrationcli certificates get [flags]
 
 * [integrationcli certificates](integrationcli_certificates.md)	 - Manage certificates used by Integration
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_certificates_list.md b/docs/integrationcli_certificates_list.md
@@ -39,4 +39,4 @@ integrationcli certificates list [flags]
 
 * [integrationcli certificates](integrationcli_certificates.md)	 - Manage certificates used by Integration
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors.md b/docs/integrationcli_connectors.md
@@ -45,4 +45,4 @@ Manage connections for Integration Connectors
 * [integrationcli connectors operations](integrationcli_connectors_operations.md)	 - View connection operations
 * [integrationcli connectors update](integrationcli_connectors_update.md)	 - Update an existing connection
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_create.md b/docs/integrationcli_connectors_create.md
@@ -10,6 +10,13 @@ Create a new connection in a region
 integrationcli connectors create [flags]
 ```
 
+### Examples
+
+```
+Create a PubSub connector and grant the Service Account permissions: integrationcli connectors create -n $name -g=true -f samples/pub_sub_connection.json -sa=connectors --wait=true --default-token
+Create a GCS Connector: integrationcli connectors create -n $name -f samples/gcs_connection.json -sa=connectors --wait=true --default-token
+```
+
 ### Options
 
 ```
@@ -44,4 +51,4 @@ integrationcli connectors create [flags]
 
 * [integrationcli connectors](integrationcli_connectors.md)	 - Manage connections for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_custom.md b/docs/integrationcli_connectors_custom.md
@@ -37,4 +37,4 @@ Manage custom connections for Integration Connectors
 * [integrationcli connectors custom list](integrationcli_connectors_custom_list.md)	 - List all custom connections
 * [integrationcli connectors custom versions](integrationcli_connectors_custom_versions.md)	 - Manage custom connection versions for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_custom_create.md b/docs/integrationcli_connectors_custom_create.md
@@ -10,6 +10,12 @@ Create a new customer connection in a region
 integrationcli connectors custom create [flags]
 ```
 
+### Examples
+
+```
+Create a custom connector for OPEN_API type: integrationcli connectors custom create -n $name -d $dispName --type OPEN_API --default-token
+```
+
 ### Options
 
 ```
@@ -18,7 +24,7 @@ integrationcli connectors custom create [flags]
   -h, --help                    help for create
   -l, --labels stringToString   Custom Connection labels (default [])
   -n, --name string             Connection name
-      --type string             Custom Connection type
+      --type ConnectorType      Custom Connection type must be set to OPEN_API or PROTO
 ```
 
 ### Options inherited from parent commands
@@ -41,4 +47,4 @@ integrationcli connectors custom create [flags]
 
 * [integrationcli connectors custom](integrationcli_connectors_custom.md)	 - Manage custom connections for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_custom_delete.md b/docs/integrationcli_connectors_custom_delete.md
@@ -38,4 +38,4 @@ integrationcli connectors custom delete [flags]
 
 * [integrationcli connectors custom](integrationcli_connectors_custom.md)	 - Manage custom connections for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_custom_get.md b/docs/integrationcli_connectors_custom_get.md
@@ -37,4 +37,4 @@ integrationcli connectors custom get [flags]
 
 * [integrationcli connectors custom](integrationcli_connectors_custom.md)	 - Manage custom connections for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_custom_list.md b/docs/integrationcli_connectors_custom_list.md
@@ -39,4 +39,4 @@ integrationcli connectors custom list [flags]
 
 * [integrationcli connectors custom](integrationcli_connectors_custom.md)	 - Manage custom connections for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_custom_versions.md b/docs/integrationcli_connectors_custom_versions.md
@@ -35,4 +35,4 @@ Manage custom connection versions for Integration Connectors
 * [integrationcli connectors custom versions get](integrationcli_connectors_custom_versions_get.md)	 - Get custom connection version details
 * [integrationcli connectors custom versions list](integrationcli_connectors_custom_versions_list.md)	 - List versions of a custom connection
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_custom_versions_create.md b/docs/integrationcli_connectors_custom_versions_create.md
@@ -10,6 +10,12 @@ Create a new customer connection version in a region
 integrationcli connectors custom versions create [flags]
 ```
 
+### Examples
+
+```
+Create a custom connection version: integrationcli connectors custom versions create --id $version -n $name -f samples/custom-connection.json --sa=connectors --default-token
+```
+
 ### Options
 
 ```
@@ -41,4 +47,4 @@ integrationcli connectors custom versions create [flags]
 
 * [integrationcli connectors custom versions](integrationcli_connectors_custom_versions.md)	 - Manage custom connection versions for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_custom_versions_get.md b/docs/integrationcli_connectors_custom_versions_get.md
@@ -39,4 +39,4 @@ integrationcli connectors custom versions get [flags]
 
 * [integrationcli connectors custom versions](integrationcli_connectors_custom_versions.md)	 - Manage custom connection versions for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_custom_versions_list.md b/docs/integrationcli_connectors_custom_versions_list.md
@@ -39,4 +39,4 @@ integrationcli connectors custom versions list [flags]
 
 * [integrationcli connectors custom versions](integrationcli_connectors_custom_versions.md)	 - Manage custom connection versions for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_delete.md b/docs/integrationcli_connectors_delete.md
@@ -37,4 +37,4 @@ integrationcli connectors delete [flags]
 
 * [integrationcli connectors](integrationcli_connectors.md)	 - Manage connections for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_eventsubs.md b/docs/integrationcli_connectors_eventsubs.md
@@ -36,4 +36,4 @@ Manage Event Subscriptions for an Integration Connector
 * [integrationcli connectors eventsubs get](integrationcli_connectors_eventsubs_get.md)	 - Get event subscription details
 * [integrationcli connectors eventsubs list](integrationcli_connectors_eventsubs_list.md)	 - List event subscriptions for a connection
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_eventsubs_create.md b/docs/integrationcli_connectors_eventsubs_create.md
@@ -39,4 +39,4 @@ integrationcli connectors eventsubs create [flags]
 
 * [integrationcli connectors eventsubs](integrationcli_connectors_eventsubs.md)	 - Manage Event Subscriptions for an Integration Connector
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_eventsubs_delete.md b/docs/integrationcli_connectors_eventsubs_delete.md
@@ -38,4 +38,4 @@ integrationcli connectors eventsubs delete [flags]
 
 * [integrationcli connectors eventsubs](integrationcli_connectors_eventsubs.md)	 - Manage Event Subscriptions for an Integration Connector
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_eventsubs_get.md b/docs/integrationcli_connectors_eventsubs_get.md
@@ -39,4 +39,4 @@ integrationcli connectors eventsubs get [flags]
 
 * [integrationcli connectors eventsubs](integrationcli_connectors_eventsubs.md)	 - Manage Event Subscriptions for an Integration Connector
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_eventsubs_list.md b/docs/integrationcli_connectors_eventsubs_list.md
@@ -41,4 +41,4 @@ integrationcli connectors eventsubs list [flags]
 
 * [integrationcli connectors eventsubs](integrationcli_connectors_eventsubs.md)	 - Manage Event Subscriptions for an Integration Connector
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_export.md b/docs/integrationcli_connectors_export.md
@@ -37,4 +37,4 @@ integrationcli connectors export [flags]
 
 * [integrationcli connectors](integrationcli_connectors.md)	 - Manage connections for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_get.md b/docs/integrationcli_connectors_get.md
@@ -40,4 +40,4 @@ integrationcli connectors get [flags]
 
 * [integrationcli connectors](integrationcli_connectors.md)	 - Manage connections for Integration Connectors
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_iam.md b/docs/integrationcli_connectors_iam.md
@@ -35,4 +35,4 @@ Manage IAM permissions for the connection
 * [integrationcli connectors iam get](integrationcli_connectors_iam_get.md)	 - Gets the IAM policy on a Connection
 * [integrationcli connectors iam setrole](integrationcli_connectors_iam_setrole.md)	 - Set Connection IAM policy on a Connection
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_iam_get.md b/docs/integrationcli_connectors_iam_get.md
@@ -37,4 +37,4 @@ integrationcli connectors iam get [flags]
 
 * [integrationcli connectors iam](integrationcli_connectors_iam.md)	 - Manage IAM permissions for the connection
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
diff --git a/docs/integrationcli_connectors_iam_setadmin.md b/docs/integrationcli_connectors_iam_setadmin.md
diff --git a/docs/integrationcli_connectors_iam_setcustom.md b/docs/integrationcli_connectors_iam_setcustom.md
diff --git a/docs/integrationcli_connectors_iam_setinvoke.md b/docs/integrationcli_connectors_iam_setinvoke.md
diff --git a/docs/integrationcli_connectors_iam_setrole.md b/docs/integrationcli_connectors_iam_setrole.md
@@ -40,4 +40,4 @@ integrationcli connectors iam setrole [flags]
 
 * [integrationcli connectors iam](integrationcli_connectors_iam.md)	 - Manage IAM permissions for the connection
 
-###### Auto generated by spf13/cobra on 10-Dec-2024
+###### Auto generated by spf13/cobra on 29-Dec-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,4 @@ integrationcli authconfigs delete [flags]

		* [integrationcli authconfigs](integrationcli_authconfigs.md) - Manage integration auth configurations

		###### Auto generated by spf13/cobra on 10-Dec-2024
		###### Auto generated by spf13/cobra on 29-Dec-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -39,4 +39,4 @@ integrationcli authconfigs get [flags]

		* [integrationcli authconfigs](integrationcli_authconfigs.md) - Manage integration auth configurations

		###### Auto generated by spf13/cobra on 10-Dec-2024
		###### Auto generated by spf13/cobra on 29-Dec-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -41,4 +41,4 @@ integrationcli certificates create [flags]

		* [integrationcli certificates](integrationcli_certificates.md) - Manage certificates used by Integration

		###### Auto generated by spf13/cobra on 10-Dec-2024
		###### Auto generated by spf13/cobra on 29-Dec-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,4 @@ integrationcli certificates delete [flags]

		* [integrationcli certificates](integrationcli_certificates.md) - Manage certificates used by Integration

		###### Auto generated by spf13/cobra on 10-Dec-2024
		###### Auto generated by spf13/cobra on 29-Dec-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -38,4 +38,4 @@ integrationcli certificates get [flags]

		* [integrationcli certificates](integrationcli_certificates.md) - Manage certificates used by Integration

		###### Auto generated by spf13/cobra on 10-Dec-2024
		###### Auto generated by spf13/cobra on 29-Dec-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -39,4 +39,4 @@ integrationcli certificates list [flags]

		* [integrationcli certificates](integrationcli_certificates.md) - Manage certificates used by Integration

		###### Auto generated by spf13/cobra on 10-Dec-2024
		###### Auto generated by spf13/cobra on 29-Dec-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -38,4 +38,4 @@ integrationcli connectors custom delete [flags]

		* [integrationcli connectors custom](integrationcli_connectors_custom.md) - Manage custom connections for Integration Connectors

		###### Auto generated by spf13/cobra on 10-Dec-2024
		###### Auto generated by spf13/cobra on 29-Dec-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,4 @@ integrationcli connectors custom get [flags]

		* [integrationcli connectors custom](integrationcli_connectors_custom.md) - Manage custom connections for Integration Connectors

		###### Auto generated by spf13/cobra on 10-Dec-2024
		###### Auto generated by spf13/cobra on 29-Dec-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -39,4 +39,4 @@ integrationcli connectors custom list [flags]

		* [integrationcli connectors custom](integrationcli_connectors_custom.md) - Manage custom connections for Integration Connectors

		###### Auto generated by spf13/cobra on 10-Dec-2024
		###### Auto generated by spf13/cobra on 29-Dec-2024
Original file line number	Diff line number	Diff line change
Expand Up		@@ -39,4 +39,4 @@ integrationcli connectors custom versions get [flags]

		* [integrationcli connectors custom versions](integrationcli_connectors_custom_versions.md) - Manage custom connection versions for Integration Connectors

		###### Auto generated by spf13/cobra on 10-Dec-2024
		###### Auto generated by spf13/cobra on 29-Dec-2024