Google Cloud Dataplex V1 Client - Class CreateEntryRequest (1.0.0-RC1)

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

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

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 Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.

↳ entry_id string

Required. Entry identifier. It has to be unique within an Entry Group. Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name. For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2. It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud. The maximum size of the field is 4000 characters.

↳ entry Google\Cloud\Dataplex\V1\Entry

Required. Entry resource.

getParent

Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.

Returns
Type Description
string

setParent

Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.

Parameter
Name Description
var string
Returns
Type Description
$this

getEntryId

Required. Entry identifier. It has to be unique within an Entry Group.

Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name. For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2. It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud. The maximum size of the field is 4000 characters.

Returns
Type Description
string

setEntryId

Required. Entry identifier. It has to be unique within an Entry Group.

Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name. For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2. It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud. The maximum size of the field is 4000 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getEntry

Required. Entry resource.

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

hasEntry

clearEntry

setEntry

Required. Entry resource.

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

static::build

Parameters
Name Description
parent string

Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. Please see Google\Cloud\Dataplex\V1\CatalogServiceClient::entryGroupName() for help formatting this field.

entry Google\Cloud\Dataplex\V1\Entry

Required. Entry resource.

entryId string

Required. Entry identifier. It has to be unique within an Entry Group.

Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name.

For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.

It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud.

The maximum size of the field is 4000 characters.

Returns
Type Description
Google\Cloud\Dataplex\V1\CreateEntryRequest