Updates the parameters of a CustomConnectorVersion.

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: connectors1 --scope <scope> projects locations-global-custom-connectors-custom-connector-versions-patch ...

Required Scalar Argument

  • <name> (string)
    • Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}

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:

CustomConnectorVersion:
  auth-config:
    auth-key: string
    auth-type: string
    oauth2-auth-code-flow:
      auth-code: string
      auth-uri: string
      client-id: string
      client-secret:
        secret-version: string
      enable-pkce: boolean
      pkce-verifier: string
      redirect-uri: string
      scopes: [string]
    oauth2-client-credentials:
      client-id: string
      client-secret:
        secret-version: string
    oauth2-jwt-bearer:
      client-key:
        secret-version: string
      jwt-claims:
        audience: string
        issuer: string
        subject: string
    ssh-public-key:
      cert-type: string
      ssh-client-cert:
        secret-version: string
      ssh-client-cert-pass:
        secret-version: string
      username: string
    user-password:
      password:
        secret-version: string
      username: string
  create-time: string
  enable-backend-destination-config: boolean
  labels: { string: string }
  name: string
  service-account: string
  spec-location: string
  state: string
  update-time: 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 .auth-config auth-key=stet
    • Identifier key for auth config
  • auth-type=duo
    • The type of authentication configured.
  • oauth2-auth-code-flow auth-code=elitr
    • Authorization code to be exchanged for access and refresh tokens.
  • auth-uri=aliquyam
    • Auth URL for Authorization Code Flow
  • client-id=erat
    • Client ID for user-provided OAuth app.
  • client-secret secret-version=ut

    • The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
  • .. enable-pkce=true

    • Whether to enable PKCE when the user performs the auth code flow.
  • pkce-verifier=rebum.
    • PKCE verifier to be used during the auth code exchange.
  • redirect-uri=et
    • Redirect URI to be provided during the auth code exchange.
  • scopes=sed

    • Scopes the connection will request when the user performs the auth code flow.
    • Each invocation of this argument appends the given value to the array.
  • ..oauth2-client-credentials client-id=stet

    • The client identifier.
  • client-secret secret-version=aliquyam

    • The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
  • ...oauth2-jwt-bearer.client-key secret-version=kasd

    • The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
  • ..jwt-claims audience=lorem

    • Value for the "aud" claim.
  • issuer=sit
    • Value for the "iss" claim.
  • subject=kasd

    • Value for the "sub" claim.
  • ...ssh-public-key cert-type=tempor

    • Format of SSH Client cert.
  • ssh-client-cert secret-version=dolor

    • The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
  • ..ssh-client-cert-pass secret-version=amet

    • The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
  • .. username=sit

    • The user account used to authenticate.
  • ..user-password.password secret-version=rebum.

    • The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/*.
  • .. username=sea

    • Username.
  • ... create-time=ipsum

    • Output only. Created time.
  • enable-backend-destination-config=false
    • Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation.
  • labels=key=eirmod
    • Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
    • the value will be associated with the given key
  • name=dolor
    • Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
  • service-account=sadipscing
    • Optional. Service account used by runtime plane to access auth config secrets.
  • spec-location=dolor
    • Optional. Location of the custom connector spec. The location can be either a public url like https://public-url.com/spec Or a Google Cloud Storage location like gs:///
  • state=dolor
    • Output only. State of the custom connector version.
  • update-time=consetetur
    • Output only. Updated time.

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
    • Required. Field mask is used to specify the fields to be overwritten in the Connector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. Set the mask as "*" for full replacement, which means all fields will be overwritten.

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