Debian Codegraph @

docs/dyn/datapipelines_v1.projects.locations.transformDescriptions.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="datapipelines_v1.html">Data pipelines API</a> . <a href="datapipelines_v1.projects.html">projects</a> . <a href="datapipelines_v1.projects.locations.html">locations</a> . <a href="datapipelines_v1.projects.locations.transformDescriptions.html">transformDescriptions</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#batchGet">batchGet(parent, names=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Gets transform descriptions in a batch, associated with a list of provided uniform resource names.</p>
80 <p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82 <p class="firstline">Close httplib2 connections.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets the transform description associated with the provided uniform resource name.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="batchGet">batchGet(parent, names=None, x__xgafv=None)</code>
89 <pre>Gets transform descriptions in a batch, associated with a list of provided uniform resource names.
90
91 Args:
92 parent: string, Required. The project and location shared by all transform descriptions being retrieved, formatted as &quot;projects/{project}/locations/{location}&quot;. (required)
93 names: string, Optional. The names of the transform descriptions being retrieved, formatted as &quot;projects/{project}/locations/{location}/transformdescriptions/{transform_description}&quot;. If no name is provided, all of the transform descriptions will be returned. (repeated)
94 x__xgafv: string, V1 error format.
95 Allowed values
96 1 - v1 error format
97 2 - v2 error format
98
99 Returns:
100 An object of the form:
101
102 { # Response message for BatchGetTransformDescriptions
103 &quot;transformDescriptions&quot;: [ # List of requested transform descriptions.
104 { # Description of a schema-aware transform, which provides info on how it can be configured.
105 &quot;name&quot;: &quot;A String&quot;, # Output only. The full name of this resource formatted as: projects/{project}/locations/{location}/transformDescriptions/{transform_description} `transform_description` is the same as the `uniform_resource_name` field.
106 &quot;options&quot;: { # Represents a simplified Apache Beam schema. # Available options for configuring the transform.
107 &quot;fields&quot;: [ # Fields in the schema. Every field within a schema must have a unique name.
108 { # Info for a single field in the schema.
109 &quot;name&quot;: &quot;A String&quot;, # Name of the field.
110 &quot;type&quot;: { # Type info about a field. # Type info for the field.
111 &quot;collectionElementType&quot;: # Object with schema name: GoogleCloudDatapipelinesV1FieldType # If `type` is an array or iterable, this is the type contained in that array or iterable.
112 &quot;logicalType&quot;: { # Represents the input for creating a specified logical type. # If `type` is a logical type, this is the info for the specific logical type.
113 &quot;enumerationType&quot;: { # Represents the Beam EnumerationType logical type. # The enum represented by this logical type.
114 &quot;values&quot;: [ # Names of the values. The numeric value is the same as the index.
115 &quot;A String&quot;,
116 ],
117 },
118 &quot;fixedBytes&quot;: { # Represents the Beam FixedBytes logical type. # The fixed-size byte collection represented by this logical type.
119 &quot;sizeBytes&quot;: 42, # Number of bytes to allocate.
120 },
121 },
122 &quot;mapType&quot;: { # Represents a map in a schema. # If `type` is a map, this is the key and value types for that map.
123 &quot;mapKeyType&quot;: # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Key type of the map. Only atomic types are supported.
124 &quot;mapValueType&quot;: # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Value type of the map.
125 },
126 &quot;nullable&quot;: True or False, # Whether or not this field is nullable.
127 &quot;rowSchema&quot;: # Object with schema name: GoogleCloudDatapipelinesV1Schema # If `type` is a row, this is the schema of that row.
128 &quot;type&quot;: &quot;A String&quot;, # Specific type of the field. For non-atomic types, the corresponding type info for that non-atomic must be set.
129 },
130 },
131 ],
132 &quot;referenceId&quot;: &quot;A String&quot;, # An identifier of the schema for looking it up in a repository. This only needs to be set if the schema is stored in a repository.
133 },
134 &quot;uniformResourceName&quot;: &quot;A String&quot;, # Unique resource name of the transform.
135 },
136 ],
137 }</pre>
138 </div>
139
140 <div class="method">
141 <code class="details" id="close">close()</code>
142 <pre>Close httplib2 connections.</pre>
143 </div>
144
145 <div class="method">
146 <code class="details" id="get">get(name, x__xgafv=None)</code>
147 <pre>Gets the transform description associated with the provided uniform resource name.
148
149 Args:
150 name: string, Required. The full name formatted as &quot;projects/{your-project}/locations/{google-cloud-region}/transformdescriptions/{uniform-resource-name}&quot;. (required)
151 x__xgafv: string, V1 error format.
152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
155
156 Returns:
157 An object of the form:
158
159 { # Description of a schema-aware transform, which provides info on how it can be configured.
160 &quot;name&quot;: &quot;A String&quot;, # Output only. The full name of this resource formatted as: projects/{project}/locations/{location}/transformDescriptions/{transform_description} `transform_description` is the same as the `uniform_resource_name` field.
161 &quot;options&quot;: { # Represents a simplified Apache Beam schema. # Available options for configuring the transform.
162 &quot;fields&quot;: [ # Fields in the schema. Every field within a schema must have a unique name.
163 { # Info for a single field in the schema.
164 &quot;name&quot;: &quot;A String&quot;, # Name of the field.
165 &quot;type&quot;: { # Type info about a field. # Type info for the field.
166 &quot;collectionElementType&quot;: # Object with schema name: GoogleCloudDatapipelinesV1FieldType # If `type` is an array or iterable, this is the type contained in that array or iterable.
167 &quot;logicalType&quot;: { # Represents the input for creating a specified logical type. # If `type` is a logical type, this is the info for the specific logical type.
168 &quot;enumerationType&quot;: { # Represents the Beam EnumerationType logical type. # The enum represented by this logical type.
169 &quot;values&quot;: [ # Names of the values. The numeric value is the same as the index.
170 &quot;A String&quot;,
171 ],
172 },
173 &quot;fixedBytes&quot;: { # Represents the Beam FixedBytes logical type. # The fixed-size byte collection represented by this logical type.
174 &quot;sizeBytes&quot;: 42, # Number of bytes to allocate.
175 },
176 },
177 &quot;mapType&quot;: { # Represents a map in a schema. # If `type` is a map, this is the key and value types for that map.
178 &quot;mapKeyType&quot;: # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Key type of the map. Only atomic types are supported.
179 &quot;mapValueType&quot;: # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Value type of the map.
180 },
181 &quot;nullable&quot;: True or False, # Whether or not this field is nullable.
182 &quot;rowSchema&quot;: # Object with schema name: GoogleCloudDatapipelinesV1Schema # If `type` is a row, this is the schema of that row.
183 &quot;type&quot;: &quot;A String&quot;, # Specific type of the field. For non-atomic types, the corresponding type info for that non-atomic must be set.
184 },
185 },
186 ],
187 &quot;referenceId&quot;: &quot;A String&quot;, # An identifier of the schema for looking it up in a repository. This only needs to be set if the schema is stored in a repository.
188 },
189 &quot;uniformResourceName&quot;: &quot;A String&quot;, # Unique resource name of the transform.
190 }</pre>
191 </div>
192
193 </body></html>