|
| 1 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 2 | +# you may not use this file except in compliance with the License. |
| 3 | +# You may obtain a copy of the License at |
| 4 | +# |
| 5 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 6 | +# |
| 7 | +# Unless required by applicable law or agreed to in writing, software |
| 8 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 9 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 10 | +# See the License for the specific language governing permissions and |
| 11 | +# limitations under the License. |
| 12 | + |
| 13 | +--- !ruby/object:Api::Resource |
| 14 | +base_url: projects/{{project}}/locations/{{location}}/connections |
| 15 | +create_url: projects/{{project}}/locations/{{location}}/connections?connectionId={{connection_id}} |
| 16 | +self_link: projects/{{project}}/locations/{{location}}/connections/{{connection_id}} |
| 17 | +id_format: projects/{{project}}/locations/{{location}}/connections/{{connection_id}} |
| 18 | +import_format: |
| 19 | + - projects/{{project}}/locations/{{location}}/connections/{{connection_id}} |
| 20 | +examples: |
| 21 | + - !ruby/object:Provider::Terraform::Examples |
| 22 | + min_version: beta |
| 23 | + name: "developer_connect_connection_basic" |
| 24 | + primary_resource_id: "my-connection" |
| 25 | + primary_resource_name: "fmt.Sprintf(\"tf-test-connection%s\", |
| 26 | + context[\"random_suffix\"\ |
| 27 | + ])" |
| 28 | + vars: |
| 29 | + connection_name: "tf-test-connection" |
| 30 | + - !ruby/object:Provider::Terraform::Examples |
| 31 | + min_version: beta |
| 32 | + name: "developer_connect_connection_github_doc" |
| 33 | + skip_test: true |
| 34 | +name: Connection |
| 35 | +description: "A connection to a GitHub App installation." |
| 36 | +min_version: "beta" |
| 37 | +update_verb: :PATCH |
| 38 | +update_mask: true |
| 39 | +autogen_async: true |
| 40 | +parameters: |
| 41 | + - !ruby/object:Api::Type::String |
| 42 | + name: location |
| 43 | + description: |
| 44 | + "Resource ID segment making up resource `name`. It identifies the resource |
| 45 | + within its parent collection as described in https://google.aip.dev/122. See documentation |
| 46 | + for resource type `developerconnect.googleapis.com/GitRepositoryLink`. " |
| 47 | + url_param_only: true |
| 48 | + required: true |
| 49 | + immutable: true |
| 50 | + - !ruby/object:Api::Type::String |
| 51 | + name: connectionId |
| 52 | + description: |
| 53 | + "Required. Id of the requesting object\nIf auto-generating Id server-side, |
| 54 | + remove this field and\nconnection_id from the method_signature of Create RPC " |
| 55 | + url_param_only: true |
| 56 | + required: true |
| 57 | + immutable: true |
| 58 | +async: !ruby/object:Api::OpAsync |
| 59 | + operation: !ruby/object:Api::OpAsync::Operation |
| 60 | + path: name |
| 61 | + base_url: "{{op_id}}" |
| 62 | + wait_ms: 1000 |
| 63 | + timeouts: |
| 64 | + result: !ruby/object:Api::OpAsync::Result |
| 65 | + path: response |
| 66 | + resource_inside_response: true |
| 67 | + status: !ruby/object:Api::OpAsync::Status |
| 68 | + path: done |
| 69 | + complete: true |
| 70 | + allowed: |
| 71 | + - true |
| 72 | + - false |
| 73 | + error: !ruby/object:Api::OpAsync::Error |
| 74 | + path: error |
| 75 | + message: message |
| 76 | +properties: |
| 77 | + - !ruby/object:Api::Type::NestedObject |
| 78 | + name: githubConfig |
| 79 | + description: "Configuration for connections to github.com. " |
| 80 | + properties: |
| 81 | + - !ruby/object:Api::Type::String |
| 82 | + name: githubApp |
| 83 | + description: |
| 84 | + "Required. Immutable. The GitHub Application that was installed to |
| 85 | + the GitHub user or\norganization. \n Possible values:\n GIT_HUB_APP_UNSPECIFIED\nDEVELOPER_CONNECT\nFIREBASE" |
| 86 | + required: true |
| 87 | + immutable: true |
| 88 | + - !ruby/object:Api::Type::NestedObject |
| 89 | + name: authorizerCredential |
| 90 | + description: |
| 91 | + "Represents an OAuth token of the account that authorized the Connection,\nand |
| 92 | + associated metadata. " |
| 93 | + properties: |
| 94 | + - !ruby/object:Api::Type::String |
| 95 | + name: oauthTokenSecretVersion |
| 96 | + description: |
| 97 | + "Required. A SecretManager resource containing the OAuth token |
| 98 | + that authorizes\nthe connection. Format: `projects/*/secrets/*/versions/*`. " |
| 99 | + required: true |
| 100 | + - !ruby/object:Api::Type::String |
| 101 | + name: username |
| 102 | + description: "Output only. The username associated with this token. " |
| 103 | + output: true |
| 104 | + - !ruby/object:Api::Type::String |
| 105 | + name: appInstallationId |
| 106 | + description: "Optional. GitHub App installation id. " |
| 107 | + - !ruby/object:Api::Type::String |
| 108 | + name: installationUri |
| 109 | + description: |
| 110 | + "Output only. The URI to navigate to in order to manage the installation |
| 111 | + associated\nwith this GitHubConfig. " |
| 112 | + output: true |
| 113 | + - !ruby/object:Api::Type::String |
| 114 | + name: name |
| 115 | + description: "Identifier. The resource name of the connection, in the format\n`projects/{project}/locations/{location}/connections/{connection_id}`. " |
| 116 | + output: true |
| 117 | + - !ruby/object:Api::Type::String |
| 118 | + name: createTime |
| 119 | + description: "Output only. [Output only] Create timestamp " |
| 120 | + output: true |
| 121 | + - !ruby/object:Api::Type::String |
| 122 | + name: updateTime |
| 123 | + description: "Output only. [Output only] Update timestamp " |
| 124 | + output: true |
| 125 | + - !ruby/object:Api::Type::String |
| 126 | + name: deleteTime |
| 127 | + description: "Output only. [Output only] Delete timestamp " |
| 128 | + output: true |
| 129 | + - !ruby/object:Api::Type::KeyValueLabels |
| 130 | + name: labels |
| 131 | + description: "Optional. Labels as key value pairs " |
| 132 | + - !ruby/object:Api::Type::NestedObject |
| 133 | + name: installationState |
| 134 | + description: |
| 135 | + "Describes stage and necessary actions to be taken by the\nuser to |
| 136 | + complete the installation. Used for GitHub and GitHub Enterprise\nbased connections. " |
| 137 | + output: true |
| 138 | + properties: |
| 139 | + - !ruby/object:Api::Type::String |
| 140 | + name: stage |
| 141 | + description: |
| 142 | + "Output only. Current step of the installation process. \n Possible |
| 143 | + values:\n STAGE_UNSPECIFIED\nPENDING_CREATE_APP\nPENDING_USER_OAUTH\nPENDING_INSTALL_APP\nCOMPLETE" |
| 144 | + output: true |
| 145 | + - !ruby/object:Api::Type::String |
| 146 | + name: message |
| 147 | + description: |
| 148 | + "Output only. Message of what the user should do next to continue |
| 149 | + the installation.\nEmpty string if the installation is already complete. " |
| 150 | + - !ruby/object:Api::Type::String |
| 151 | + name: actionUri |
| 152 | + description: |
| 153 | + "Output only. Link to follow for next action. Empty string if the |
| 154 | + installation is already\ncomplete. " |
| 155 | + - !ruby/object:Api::Type::Boolean |
| 156 | + name: disabled |
| 157 | + description: |
| 158 | + "Optional. If disabled is set to true, functionality is disabled for |
| 159 | + this connection.\nRepository based API methods and webhooks processing for repositories |
| 160 | + in\nthis connection will be disabled. " |
| 161 | + - !ruby/object:Api::Type::Boolean |
| 162 | + name: reconciling |
| 163 | + description: |
| 164 | + "Output only. Set to true when the connection is being set up or updated |
| 165 | + in the\nbackground. " |
| 166 | + output: true |
| 167 | + - !ruby/object:Api::Type::KeyValueAnnotations |
| 168 | + name: annotations |
| 169 | + description: "Optional. Allows clients to store small amounts of arbitrary data. " |
| 170 | + - !ruby/object:Api::Type::String |
| 171 | + name: etag |
| 172 | + description: |
| 173 | + "Optional. This checksum is computed by the server based on the value |
| 174 | + of other\nfields, and may be sent on update and delete requests to ensure the\nclient |
| 175 | + has an up-to-date value before proceeding. " |
| 176 | + - !ruby/object:Api::Type::String |
| 177 | + name: uid |
| 178 | + description: "Output only. A system-assigned unique identifier for a the GitRepositoryLink. " |
| 179 | + output: true |
0 commit comments