Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects of a parent data object that's optionally supplied in the request.

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-discover ...

Required Scalar Argument

  • <parent> (string)
    • Required. The parent resource of the connection profile type. Must be in the format projects/*/locations/*.

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:

DiscoverConnectionProfileRequest:
  connection-profile:
    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
  connection-profile-name: string
  full-hierarchy: boolean
  hierarchy-depth: integer

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 .connection-profile create-time=et
    • Output only. The create time of the resource.
  • display-name=sed
    • Required. Display name.
  • forward-ssh-connectivity hostname=et
    • Required. Hostname for the SSH tunnel.
  • password=et
    • Input only. SSH password.
  • port=25
    • Port for the SSH tunnel, default value is 22.
  • private-key=erat
    • Input only. SSH private key.

  • username=sed

    • Required. Username for the SSH tunnel.

  • ..gcs-profile bucket=duo

    • Required. The Cloud Storage bucket name.

  • root-path=dolore

    • The root path inside the Cloud Storage bucket.

  • .. labels=key=et

    • Labels.
    • the value will be associated with the given key
  • mysql-profile hostname=voluptua.
    • Required. Hostname for the MySQL connection.
  • password=amet.
    • Required. Input only. Password for the MySQL connection.
  • port=5
    • Port for the MySQL connection, default value is 3306.
  • ssl-config ca-certificate=diam
    • Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
  • ca-certificate-set=true
    • 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=false
    • Output only. Indicates whether the client_certificate field is set.
  • client-key=stet
    • 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=false

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

  • .. username=duo

    • Required. Username for the MySQL connection.

  • .. name=vero

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

  • ca-certificate-set=true

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

  • .. password=lorem

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

  • username=no

    • Required. Username for the Oracle connection.

  • ..postgresql-profile database=ipsum

    • Required. Database for the PostgreSQL connection.
  • hostname=accusam
    • Required. Hostname for the PostgreSQL connection.
  • password=takimata
    • Required. Password for the PostgreSQL connection.
  • port=55
    • Port for the PostgreSQL connection, default value is 5432.

  • username=voluptua.

    • Required. Username for the PostgreSQL connection.

  • ..private-connectivity private-connection=et

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

  • ..sql-server-profile database=erat

    • Required. Database for the SQLServer connection.
  • hostname=consetetur
    • Required. Hostname for the SQLServer connection.
  • password=amet.
    • Required. Password for the SQLServer connection.
  • port=71
    • Port for the SQLServer connection, default value is 1433.

  • username=takimata

    • Required. Username for the SQLServer connection.

  • .. update-time=dolores

    • Output only. The update time of the resource.

  • .. connection-profile-name=gubergren

    • A reference to an existing connection profile.
  • full-hierarchy=false
    • Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).
  • hierarchy-depth=78
    • The number of hierarchy levels below the current level to be retrieved.

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