Create a new domain mapping.

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: run1 --scope <scope> namespaces domainmappings-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The namespace in which the domain mapping should be created. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_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:

DomainMapping:
  api-version: string
  kind: string
  metadata:
    annotations: { string: string }
    cluster-name: string
    creation-timestamp: string
    deletion-grace-period-seconds: integer
    deletion-timestamp: string
    finalizers: [string]
    generate-name: string
    generation: integer
    labels: { string: string }
    name: string
    namespace: string
    resource-version: string
    self-link: string
    uid: string
  spec:
    certificate-mode: string
    force-override: boolean
    route-name: string
  status:
    mapped-route-name: string
    observed-generation: integer
    url: 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 . api-version=et
    • The API version for this call such as "domains.cloudrun.com/v1".
  • kind=magna
    • The kind of resource, in this case "DomainMapping".
  • metadata annotations=key=no
    • Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision . * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/default-url-disabled: Service. * run.googleapis.com/description: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/minScale: Service (ALPHA) * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.
    • the value will be associated with the given key
  • cluster-name=ipsum
    • Not supported by Cloud Run
  • creation-timestamp=voluptua.
    • UTC timestamp representing the server time when this object was created.
  • deletion-grace-period-seconds=74
    • Not supported by Cloud Run
  • deletion-timestamp=sanctus
    • The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.
  • finalizers=sed
    • Not supported by Cloud Run
    • Each invocation of this argument appends the given value to the array.
  • generate-name=amet.
    • Not supported by Cloud Run
  • generation=42
    • A system-provided sequence number representing a specific generation of the desired state.
  • labels=key=amet.
    • Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.
    • the value will be associated with the given key
  • name=duo
    • Required. The name of the resource. Name is required when creating top-level resources (Service, Job), must be unique within a Cloud Run project/region, and cannot be changed once created.
  • namespace=ipsum
    • Required. Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.
  • resource-version=gubergren
    • Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection.
  • self-link=lorem
    • URL representing this object.
  • uid=gubergren

    • Unique, system-generated identifier for this resource.
  • ..spec certificate-mode=eos

    • The mode of the certificate.
  • force-override=true
    • If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
  • route-name=invidunt

    • The name of the Knative Route that this DomainMapping applies to. The route must exist.
  • ..status mapped-route-name=amet

    • The name of the route that the mapping currently points to.
  • observed-generation=81
    • ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.
  • url=ipsum
    • Optional. Not supported by Cloud Run.

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 dry-run=string
    • Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

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