Blame - docs/dyn/dataflow_v1b3.projects.templateVersions.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

81

<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

82

<p class="firstline">List TemplateVersions using project_id and an optional display_name field. List all the TemplateVersions in the Template if display set. List all the TemplateVersions in the Project if display_name not set.</p>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

83

84

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

<h3>Method Details</h3>

87

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

88

<code class="details" id="close">close()</code>

89

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

93

<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

94

<pre>List TemplateVersions using project_id and an optional display_name field. List all the TemplateVersions in the Template if display set. List all the TemplateVersions in the Project if display_name not set.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

95

96

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

parent: string, parent includes project_id, and display_name is optional. List by project_id(pid1) and display_name(tid1). Format: projects/{pid1}/catalogTemplates/{tid1} List by project_id(pid1). Format: projects/{pid1} (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

98

pageSize: integer, The maximum number of TemplateVersions to return per page.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

99

pageToken: string, The page token, received from a previous ListTemplateVersions call. Provide this to retrieve the subsequent page.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

100

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

107

108

{ # Respond a list of TemplateVersions.

109

"templateVersions": [ # A list of TemplateVersions.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

110

{ # ///////////////////////////////////////////////////////////////////////////// //// Template Catalog is used to organize user TemplateVersions. //// TemplateVersions that have the same project_id and display_name are //// belong to the same Template. //// Templates with the same project_id belong to the same Project. //// TemplateVersion may have labels and multiple labels are allowed. //// Duplicated labels in the same `TemplateVersion` are not allowed. //// TemplateVersion may have tags and multiple tags are allowed. Duplicated //// tags in the same `Template` are not allowed!

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

111

"type": "A String", # Either LEGACY or FLEX. This should match with the type of artifact.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

112

"projectId": "A String", # A unique project_id. Multiple Templates per Project.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

113

"labels": { # Labels for the Template Version. Labels can be duplicate within Template.

114

"a_key": "A String",

115

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

116

"tags": [ # Alias for version_id, helps locate a TemplateVersion.

117

"A String",

118

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

119

"displayName": "A String", # A customized name for Template. Multiple TemplateVersions per Template.

120

"versionId": "A String", # An auto generated version_id for TemplateVersion.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

121

"artifact": { # Job information for templates. # Job graph and metadata if it is a legacy Template. Container image path and metadata if it is flex Template.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

122

"metadata": { # Metadata describing a template. # Metadata set for legacy Template.

123

"description": "A String", # Optional. A description of the template.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

124

"parameters": [ # The parameters for the template.

125

{ # Metadata for a specific parameter.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

126

"regexes": [ # Optional. Regexes that the parameter must match.

127

"A String",

128

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

129

"isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.

130

"label": "A String", # Required. The label to display for the parameter.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

131

"name": "A String", # Required. The name of the parameter.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

132

"paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.

133

"helpText": "A String", # Required. The help text to display for the parameter.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

134

},

135

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

136

"name": "A String", # Required. The name of the template.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

137

},

138

"containerSpec": { # Container Spec. # Container image path set for flex Template.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

139

"metadata": { # Metadata describing a template. # Metadata describing a template including description and validation rules.

140

"description": "A String", # Optional. A description of the template.

141

"parameters": [ # The parameters for the template.

142

{ # Metadata for a specific parameter.

143

"regexes": [ # Optional. Regexes that the parameter must match.

144

"A String",

145

],

146

"isOptional": True or False, # Optional. Whether the parameter is optional. Defaults to false.

147

"label": "A String", # Required. The label to display for the parameter.

148

"name": "A String", # Required. The name of the parameter.

149

"paramType": "A String", # Optional. The type of the parameter. Used for selecting input picker.

150

"helpText": "A String", # Required. The help text to display for the parameter.

151

},

152

],

153

"name": "A String", # Required. The name of the template.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

154

},

155

"defaultEnvironment": { # The environment values to be set at runtime for flex template. # Default runtime environment for the job.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

156

"maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

157

"numWorkers": 42, # The initial number of Google Compute Engine instances for the job.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

158

"additionalExperiments": [ # Additional experiment flags for the job.

159

"A String",

160

],

161

"kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

162

"machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

163

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.

164

"tempLocation": "A String", # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

165

"additionalUserLabels": { # Additional user labels to be specified for the job. Keys and values must follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.

166

"a_key": "A String",

167

},

168

"enableStreamingEngine": True or False, # Whether to enable Streaming Engine for the job.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

169

"workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

170

"ipConfiguration": "A String", # Configuration for VM IPs.

171

"workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.

172

"zone": "A String", # The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.

173

"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

174

"serviceAccountEmail": "A String", # The email address of the service account to run the job as.

175

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

176

"sdkInfo": { # SDK Information. # Required. SDK info of the Flex Template.

177

"language": "A String", # Required. The SDK Language.

178

"version": "A String", # Optional. The SDK version.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

179

},

180

"image": "A String", # Name of the docker container image. E.g., gcr.io/project/some-image

181

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

182

"jobGraphGcsPath": "A String", # job_graph_gcs_path set for legacy Template.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

183

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

184

"createTime": "A String", # Creation time of this TemplateVersion.

185

"description": "A String", # Template description from the user.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

186

},

187

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

188

"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

Bu Sun Kim