Creates a new backup in a given project and location.

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: metastore1-beta --scope <scope> projects locations-services-backups-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The relative resource name of the service in which to create a backup of the following form:projects/{project_number}/locations/{location_id}/services/{service_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:

Backup:
  create-time: string
  description: string
  end-time: string
  name: string
  restoring-services: [string]
  service-revision:
    artifact-gcs-uri: string
    create-time: string
    database-type: string
    encryption-config:
      kms-key: string
    endpoint-uri: string
    hive-metastore-config:
      config-overrides: { string: string }
      endpoint-protocol: string
      kerberos-config:
        keytab:
          cloud-secret: string
        krb5-config-gcs-uri: string
        principal: string
      version: string
    labels: { string: string }
    maintenance-window:
      day-of-week: string
      hour-of-day: integer
    metadata-integration:
      data-catalog-config:
        enabled: boolean
    name: string
    network: string
    network-config:
      custom-routes-enabled: boolean
    port: integer
    release-channel: string
    scaling-config:
      instance-size: string
      scaling-factor: number
    scheduled-backup:
      backup-location: string
      cron-schedule: string
      enabled: boolean
      latest-backup:
        backup-id: string
        duration: string
        start-time: string
        state: string
      next-scheduled-time: string
      time-zone: string
    state: string
    state-message: string
    telemetry-config:
      log-format: string
    tier: string
    uid: string
    update-time: string
  state: 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=rebum.
    • Output only. The time when the backup was started.
  • description=est
    • The description of the backup.
  • end-time=ipsum
    • Output only. The time when the backup finished creating.
  • name=ipsum
    • Immutable. The relative resource name of the backup, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}
  • restoring-services=est
    • Output only. Services that are restoring from the backup.
    • Each invocation of this argument appends the given value to the array.
  • service-revision artifact-gcs-uri=gubergren
    • Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.
  • create-time=ea
    • Output only. The time when the metastore service was created.
  • database-type=dolor
    • Immutable. The database type that the Metastore service stores its data.

  • encryption-config kms-key=lorem

    • The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following form:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.

  • .. endpoint-uri=eos

    • Output only. The URI of the endpoint used to access the metastore service.
  • hive-metastore-config config-overrides=key=labore
    • A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version's AuxiliaryVersionConfig.
    • the value will be associated with the given key
  • endpoint-protocol=sed
    • The protocol to use for the metastore service endpoint. If unspecified, defaults to THRIFT.

  • kerberos-config.keytab cloud-secret=duo

    • The relative resource name of a Secret Manager secret version, in the following form:projects/{project_number}/secrets/{secret_id}/versions/{version_id}.

  • .. krb5-config-gcs-uri=sed

    • A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.

  • principal=no

    • A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form primary/instance@REALM, but there is no exact format.

  • .. version=stet

    • Immutable. The Hive metastore schema version.

  • .. labels=key=kasd

    • User-defined labels for the metastore service.
    • the value will be associated with the given key
  • maintenance-window day-of-week=et
    • The day of week, when the window starts.

  • hour-of-day=58

    • The hour of day (0-23) when the window starts.

  • ..metadata-integration.data-catalog-config enabled=true

    • Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.

  • ... name=vero

    • Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
  • network=erat
    • Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}.

  • network-config custom-routes-enabled=false

    • Enables custom routes to be imported and exported for the Dataproc Metastore service's peered VPC network.

  • .. port=81

    • The TCP port at which the metastore service is reached. Default: 9083.
  • release-channel=dolore
    • Immutable. The release channel of the service. If unspecified, defaults to STABLE.
  • scaling-config instance-size=et
    • An enum of readable instance sizes, with each instance size mapping to a float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1))

  • scaling-factor=0.9697780726648698

    • Scaling factor, increments of 0.1 for values less than 1.0, and increments of 1.0 for values greater than 1.0.

  • ..scheduled-backup backup-location=amet.

    • Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.
  • cron-schedule=consetetur
    • Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.
  • enabled=false
    • Optional. Defines whether the scheduled backup is enabled. The default value is false.
  • latest-backup backup-id=dolor
    • Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.
  • duration=et
    • Output only. The duration of the backup completion.
  • start-time=et
    • Output only. The time when the backup was started.

  • state=sadipscing

    • Output only. The current state of the backup.

  • .. next-scheduled-time=stet

    • Output only. The time when the next backups execution is scheduled to start.

  • time-zone=dolor

    • Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.

  • .. state=duo

    • Output only. The current state of the metastore service.
  • state-message=vero
    • Output only. Additional information about the current state of the metastore service, if available.

  • telemetry-config log-format=vero

    • The output format of the Dataproc Metastore service's logs.

  • .. tier=invidunt

    • The tier of the service.
  • uid=stet
    • Output only. The globally unique resource identifier of the metastore service.

  • update-time=vero

    • Output only. The time when the metastore service was last updated.

  • .. state=elitr

    • Output only. The current state of the backup.

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 backup-id=string

    • Required. The ID of the backup, which is used as the final component of the backup's name.This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.

  • -p request-id=string

    • Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

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