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