blob: a3fadd9c31932a63b3eeebc346d803dda78c7670 [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dataplex_v1.html">Cloud Dataplex API</a> . <a href="dataplex_v1.projects.html">projects</a> . <a href="dataplex_v1.projects.locations.html">locations</a> . <a href="dataplex_v1.projects.locations.entryGroups.html">entryGroups</a> . <a href="dataplex_v1.projects.locations.entryGroups.entryLinks.html">entryLinks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, entryLinkId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an Entry Link.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an Entry Link.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an Entry Link.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, entryLinkId=None, x__xgafv=None)</code>
<pre>Creates an Entry Link.
Args:
parent: string, Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. (required)
body: object, The request body.
The object takes the form of:
{ # EntryLink represents a link between two Entries.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Entry Link was created.
&quot;entryLinkType&quot;: &quot;A String&quot;, # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
&quot;entryReferences&quot;: [ # Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
{ # Reference to the Entry that is linked through the Entry Link.
&quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
&quot;path&quot;: &quot;A String&quot;, # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The reference type of the Entry.
},
],
&quot;name&quot;: &quot;A String&quot;, # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Entry Link was last updated.
}
entryLinkId: string, Required. Entry Link 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 EntryGroup.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # EntryLink represents a link between two Entries.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Entry Link was created.
&quot;entryLinkType&quot;: &quot;A String&quot;, # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
&quot;entryReferences&quot;: [ # Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
{ # Reference to the Entry that is linked through the Entry Link.
&quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
&quot;path&quot;: &quot;A String&quot;, # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The reference type of the Entry.
},
],
&quot;name&quot;: &quot;A String&quot;, # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Entry Link was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an Entry Link.
Args:
name: string, Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # EntryLink represents a link between two Entries.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Entry Link was created.
&quot;entryLinkType&quot;: &quot;A String&quot;, # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
&quot;entryReferences&quot;: [ # Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
{ # Reference to the Entry that is linked through the Entry Link.
&quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
&quot;path&quot;: &quot;A String&quot;, # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The reference type of the Entry.
},
],
&quot;name&quot;: &quot;A String&quot;, # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Entry Link was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets an Entry Link.
Args:
name: string, Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # EntryLink represents a link between two Entries.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the Entry Link was created.
&quot;entryLinkType&quot;: &quot;A String&quot;, # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
&quot;entryReferences&quot;: [ # Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
{ # Reference to the Entry that is linked through the Entry Link.
&quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
&quot;path&quot;: &quot;A String&quot;, # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The reference type of the Entry.
},
],
&quot;name&quot;: &quot;A String&quot;, # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the Entry Link was last updated.
}</pre>
</div>
</body></html>