Update an association between a GCP project and a GitHub Enterprise server.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: cloudbuild1 --scope <scope> projects github-enterprise-configs-patch ...

Required Scalar Argument

  • <name> (string)
    • Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GitHubEnterpriseConfig:
  app-id: string
  create-time: string
  display-name: string
  host-url: string
  name: string
  peered-network: string
  secrets:
    oauth-client-id-name: string
    oauth-client-id-version-name: string
    oauth-secret-name: string
    oauth-secret-version-name: string
    private-key-name: string
    private-key-version-name: string
    webhook-secret-name: string
    webhook-secret-version-name: string
  ssl-ca: string
  webhook-key: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . app-id=aliquyam
    • Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
  • create-time=amet
    • Output only. Time when the installation was associated with the project.
  • display-name=est
    • Name to display for this config.
  • host-url=et
    • The URL of the github enterprise host the configuration is for.
  • name=sea
    • Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
  • peered-network=consetetur
    • Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
  • secrets oauth-client-id-name=consetetur
    • The resource name for the OAuth client ID secret in Secret Manager.
  • oauth-client-id-version-name=stet
    • The resource name for the OAuth client ID secret version in Secret Manager.
  • oauth-secret-name=est
    • The resource name for the OAuth secret in Secret Manager.
  • oauth-secret-version-name=aliquyam
    • The resource name for the OAuth secret secret version in Secret Manager.
  • private-key-name=elitr
    • The resource name for the private key secret.
  • private-key-version-name=duo
    • The resource name for the private key secret version.
  • webhook-secret-name=diam
    • The resource name for the webhook secret in Secret Manager.

  • webhook-secret-version-name=est

    • The resource name for the webhook secret secret version in Secret Manager.

  • .. ssl-ca=sit

    • Optional. SSL certificate to use for requests to GitHub Enterprise.
  • webhook-key=sed
    • The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p update-mask=string
    • Update mask for the resource. If this is set, the server will only update the fields specified in the field mask. Otherwise, a full update of the mutable resource fields will be performed.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").