Skip to content
This repository was archived by the owner on Jul 20, 2023. It is now read-only.

Commit ff9bb33

Browse files
docs: add samples to README
1 parent 42fc504 commit ff9bb33

File tree

6 files changed

+366
-136
lines changed

6 files changed

+366
-136
lines changed

.kokoro/samples-test.sh

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,17 @@ has instructions for running the samples.
8787

8888
| Sample | Source Code | Try it |
8989
| --------------------------- | --------------------------------- | ------ |
90+
| Create Job From Ad Hoc | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/createJobFromAdHoc.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/createJobFromAdHoc.js,samples/README.md) |
91+
| Create Job From Preset | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/createJobFromPreset.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/createJobFromPreset.js,samples/README.md) |
92+
| Create Job From Template | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/createJobFromTemplate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/createJobFromTemplate.js,samples/README.md) |
93+
| Create Job Template | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/createJobTemplate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/createJobTemplate.js,samples/README.md) |
94+
| Delete Job | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/deleteJob.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/deleteJob.js,samples/README.md) |
95+
| Delete Job Template | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/deleteJobTemplate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/deleteJobTemplate.js,samples/README.md) |
96+
| Get Job | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/getJob.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/getJob.js,samples/README.md) |
97+
| Get Job State | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/getJobState.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/getJobState.js,samples/README.md) |
98+
| Get Job Template | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/getJobTemplate.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/getJobTemplate.js,samples/README.md) |
99+
| List Job Templates | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/listJobTemplates.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/listJobTemplates.js,samples/README.md) |
100+
| List Jobs | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/listJobs.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/listJobs.js,samples/README.md) |
90101
| Quickstart | [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
91102

92103

protos/protos.json

Lines changed: 90 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

samples/README.md

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@
1212

1313
* [Before you begin](#before-you-begin)
1414
* [Samples](#samples)
15+
* [Create Job From Ad Hoc](#create-job-from-ad-hoc)
16+
* [Create Job From Preset](#create-job-from-preset)
17+
* [Create Job From Template](#create-job-from-template)
18+
* [Create Job Template](#create-job-template)
19+
* [Delete Job](#delete-job)
20+
* [Delete Job Template](#delete-job-template)
21+
* [Get Job](#get-job)
22+
* [Get Job State](#get-job-state)
23+
* [Get Job Template](#get-job-template)
24+
* [List Job Templates](#list-job-templates)
25+
* [List Jobs](#list-jobs)
1526
* [Quickstart](#quickstart)
1627

1728
## Before you begin
@@ -29,6 +40,193 @@ Before running the samples, make sure you've followed the steps outlined in
2940

3041

3142

43+
### Create Job From Ad Hoc
44+
45+
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/createJobFromAdHoc.js).
46+
47+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/createJobFromAdHoc.js,samples/README.md)
48+
49+
__Usage:__
50+
51+
52+
`node samples/createJobFromAdHoc.js`
53+
54+
55+
-----
56+
57+
58+
59+
60+
### Create Job From Preset
61+
62+
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/createJobFromPreset.js).
63+
64+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/createJobFromPreset.js,samples/README.md)
65+
66+
__Usage:__
67+
68+
69+
`node samples/createJobFromPreset.js`
70+
71+
72+
-----
73+
74+
75+
76+
77+
### Create Job From Template
78+
79+
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/createJobFromTemplate.js).
80+
81+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/createJobFromTemplate.js,samples/README.md)
82+
83+
__Usage:__
84+
85+
86+
`node samples/createJobFromTemplate.js`
87+
88+
89+
-----
90+
91+
92+
93+
94+
### Create Job Template
95+
96+
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/createJobTemplate.js).
97+
98+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/createJobTemplate.js,samples/README.md)
99+
100+
__Usage:__
101+
102+
103+
`node samples/createJobTemplate.js`
104+
105+
106+
-----
107+
108+
109+
110+
111+
### Delete Job
112+
113+
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/deleteJob.js).
114+
115+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/deleteJob.js,samples/README.md)
116+
117+
__Usage:__
118+
119+
120+
`node samples/deleteJob.js`
121+
122+
123+
-----
124+
125+
126+
127+
128+
### Delete Job Template
129+
130+
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/deleteJobTemplate.js).
131+
132+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/deleteJobTemplate.js,samples/README.md)
133+
134+
__Usage:__
135+
136+
137+
`node samples/deleteJobTemplate.js`
138+
139+
140+
-----
141+
142+
143+
144+
145+
### Get Job
146+
147+
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/getJob.js).
148+
149+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/getJob.js,samples/README.md)
150+
151+
__Usage:__
152+
153+
154+
`node samples/getJob.js`
155+
156+
157+
-----
158+
159+
160+
161+
162+
### Get Job State
163+
164+
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/getJobState.js).
165+
166+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/getJobState.js,samples/README.md)
167+
168+
__Usage:__
169+
170+
171+
`node samples/getJobState.js`
172+
173+
174+
-----
175+
176+
177+
178+
179+
### Get Job Template
180+
181+
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/getJobTemplate.js).
182+
183+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/getJobTemplate.js,samples/README.md)
184+
185+
__Usage:__
186+
187+
188+
`node samples/getJobTemplate.js`
189+
190+
191+
-----
192+
193+
194+
195+
196+
### List Job Templates
197+
198+
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/listJobTemplates.js).
199+
200+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/listJobTemplates.js,samples/README.md)
201+
202+
__Usage:__
203+
204+
205+
`node samples/listJobTemplates.js`
206+
207+
208+
-----
209+
210+
211+
212+
213+
### List Jobs
214+
215+
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/listJobs.js).
216+
217+
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-transcoder&page=editor&open_in_editor=samples/listJobs.js,samples/README.md)
218+
219+
__Usage:__
220+
221+
222+
`node samples/listJobs.js`
223+
224+
225+
-----
226+
227+
228+
229+
32230
### Quickstart
33231

34232
View the [source code](https://github.com/googleapis/nodejs-video-transcoder/blob/master/samples/quickstart.js).

0 commit comments

Comments
 (0)