Use this method to update the parameters of a connection profile.

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: datastream1 --scope <scope> projects locations-connection-profiles-patch ...

Required Scalar Argument

  • <name> (string)
    • Output only. The resource's name.

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:

ConnectionProfile:
  create-time: string
  display-name: string
  forward-ssh-connectivity:
    hostname: string
    password: string
    port: integer
    private-key: string
    username: string
  gcs-profile:
    bucket: string
    root-path: string
  labels: { string: string }
  mysql-profile:
    hostname: string
    password: string
    port: integer
    ssl-config:
      ca-certificate: string
      ca-certificate-set: boolean
      client-certificate: string
      client-certificate-set: boolean
      client-key: string
      client-key-set: boolean
    username: string
  name: string
  oracle-profile:
    connection-attributes: { string: string }
    database-service: string
    hostname: string
    oracle-ssl-config:
      ca-certificate: string
      ca-certificate-set: boolean
    password: string
    port: integer
    username: string
  postgresql-profile:
    database: string
    hostname: string
    password: string
    port: integer
    username: string
  private-connectivity:
    private-connection: string
  sql-server-profile:
    database: string
    hostname: string
    password: string
    port: integer
    username: 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 . create-time=voluptua.
    • Output only. The create time of the resource.
  • display-name=dolore
    • Required. Display name.
  • forward-ssh-connectivity hostname=dolore
    • Required. Hostname for the SSH tunnel.
  • password=dolore
    • Input only. SSH password.
  • port=23
    • Port for the SSH tunnel, default value is 22.
  • private-key=amet.
    • Input only. SSH private key.

  • username=ea

    • Required. Username for the SSH tunnel.

  • ..gcs-profile bucket=sadipscing

    • Required. The Cloud Storage bucket name.

  • root-path=lorem

    • The root path inside the Cloud Storage bucket.

  • .. labels=key=invidunt

    • Labels.
    • the value will be associated with the given key
  • mysql-profile hostname=no
    • Required. Hostname for the MySQL connection.
  • password=est
    • Required. Input only. Password for the MySQL connection.
  • port=74
    • Port for the MySQL connection, default value is 3306.
  • ssl-config ca-certificate=sed
    • Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
  • ca-certificate-set=false
    • Output only. Indicates whether the ca_certificate field is set.
  • client-certificate=et
    • Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
  • client-certificate-set=true
    • Output only. Indicates whether the client_certificate field is set.
  • client-key=aliquyam
    • Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.

  • client-key-set=true

    • Output only. Indicates whether the client_key field is set.

  • .. username=est

    • Required. Username for the MySQL connection.

  • .. name=sed

    • Output only. The resource's name.
  • oracle-profile connection-attributes=key=diam
    • Connection string attributes
    • the value will be associated with the given key
  • database-service=dolores
    • Required. Database for the Oracle connection.
  • hostname=dolores
    • Required. Hostname for the Oracle connection.
  • oracle-ssl-config ca-certificate=et
    • Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.

  • ca-certificate-set=false

    • Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile.

  • .. password=no

    • Required. Password for the Oracle connection.
  • port=16
    • Port for the Oracle connection, default value is 1521.

  • username=elitr

    • Required. Username for the Oracle connection.

  • ..postgresql-profile database=sed

    • Required. Database for the PostgreSQL connection.
  • hostname=no
    • Required. Hostname for the PostgreSQL connection.
  • password=nonumy
    • Required. Password for the PostgreSQL connection.
  • port=24
    • Port for the PostgreSQL connection, default value is 5432.

  • username=sadipscing

    • Required. Username for the PostgreSQL connection.

  • ..private-connectivity private-connection=aliquyam

    • Required. A reference to a private connection resource. Format: projects/{project}/locations/{location}/privateConnections/{name}

  • ..sql-server-profile database=dolores

    • Required. Database for the SQLServer connection.
  • hostname=sadipscing
    • Required. Hostname for the SQLServer connection.
  • password=erat
    • Required. Password for the SQLServer connection.
  • port=19
    • Port for the SQLServer connection, default value is 1433.

  • username=amet

    • Required. Username for the SQLServer connection.

  • .. update-time=est

    • Output only. The update time of the resource.

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 force=boolean

    • Optional. Update the connection profile without validating it.

  • -p request-id=string

    • Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • -p update-mask=string

    • Optional. Field mask is used to specify the fields to be overwritten in the ConnectionProfile 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. If the user does not provide a mask then all fields will be overwritten.

  • -p validate-only=boolean

    • Optional. Only validate the connection profile, but don't update any resources. The default is false.

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