Google Cloud Dataplex V1 Client - Class CreateEnvironmentRequest (0.15.1)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class CreateEnvironmentRequest.

Create environment request.

Generated from protobuf message google.cloud.dataplex.v1.CreateEnvironmentRequest

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.
↳ environment_id string

Required. Environment identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the lake.
↳ environment Google\Cloud\Dataplex\V1\Environment

Required. Environment resource.
↳ validate_only bool

Optional. Only validate the request, but do not perform mutations. The default is false.

getParent

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.

Returns
Type Description
string

setParent

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getEnvironmentId

Required. Environment identifier.

  • Must contain only lowercase letters, numbers and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the lake.
Returns
Type Description
string

setEnvironmentId

Required. Environment identifier.

  • Must contain only lowercase letters, numbers and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the lake.
Parameter
Name Description
var string
Returns
Type Description
$this

getEnvironment

Required. Environment resource.

Returns
Type Description
Google\Cloud\Dataplex\V1\Environment|null

hasEnvironment

clearEnvironment

setEnvironment

Required. Environment resource.

Parameter
Name Description
var Google\Cloud\Dataplex\V1\Environment
Returns
Type Description
$this

getValidateOnly

Optional. Only validate the request, but do not perform mutations.

The default is false.

Returns
Type Description
bool

setValidateOnly

Optional. Only validate the request, but do not perform mutations.

The default is false.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}. Please see Google\Cloud\Dataplex\V1\DataplexServiceClient::lakeName() for help formatting this field.
environment Google\Cloud\Dataplex\V1\Environment

Required. Environment resource.
environmentId string

Required. Environment identifier.

  • Must contain only lowercase letters, numbers and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the lake.
Returns
Type Description
Google\Cloud\Dataplex\V1\CreateEnvironmentRequest