Creates a new Consent artifact in the parent consent store.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-healthcare. You can set the scope for this method like this: healthcare1 --scope <scope> projects locations-datasets-consent-stores-consent-artifacts-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The name of the consent store this Consent artifact belongs to.

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:

ConsentArtifact:
  consent-content-version: string
  guardian-signature:
    image:
      gcs-uri: string
      raw-bytes: string
    metadata: { string: string }
    signature-time: string
    user-id: string
  metadata: { string: string }
  name: string
  user-id: string
  user-signature:
    image:
      gcs-uri: string
      raw-bytes: string
    metadata: { string: string }
    signature-time: string
    user-id: string
  witness-signature:
    image:
      gcs-uri: string
      raw-bytes: string
    metadata: { string: string }
    signature-time: string
    user-id: 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 . consent-content-version=eos
    • Optional. An string indicating the version of the consent information shown to the user.
  • guardian-signature.image gcs-uri=dolor
    • Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
  • raw-bytes=ea

    • Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
  • .. metadata=key=ipsum

    • Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    • the value will be associated with the given key
  • signature-time=invidunt
    • Optional. Timestamp of the signature.
  • user-id=amet

    • Required. User's UUID provided by the client.
  • .. metadata=key=duo

    • Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
    • the value will be associated with the given key
  • name=ipsum
    • Identifier. Resource name of the Consent artifact, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}. Cannot be changed after creation.
  • user-id=sed
    • Required. User's UUID provided by the client.
  • user-signature.image gcs-uri=ut
    • Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
  • raw-bytes=gubergren

    • Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
  • .. metadata=key=rebum.

    • Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    • the value will be associated with the given key
  • signature-time=est
    • Optional. Timestamp of the signature.
  • user-id=ipsum

    • Required. User's UUID provided by the client.
  • ..witness-signature.image gcs-uri=ipsum

    • Input only. Points to a Cloud Storage URI containing the consent artifact content. The URI must be in the following format: gs://{bucket_id}/{object_id}. The Cloud Healthcare API service account must have the roles/storage.objectViewer Cloud IAM role for this Cloud Storage location. The consent artifact content at this URI is copied to a Cloud Storage location managed by the Cloud Healthcare API. Responses to fetching requests return the consent artifact content in raw_bytes.
  • raw-bytes=est

    • Consent artifact content represented as a stream of bytes. This field is populated when returned in GetConsentArtifact response, but not included in CreateConsentArtifact and ListConsentArtifact response.
  • .. metadata=key=gubergren

    • Optional. Metadata associated with the user's signature. For example, the user's name or the user's title.
    • the value will be associated with the given key
  • signature-time=ea
    • Optional. Timestamp of the signature.
  • user-id=dolor
    • Required. User's UUID provided by the client.

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