feat: add initial samples (#2)

* feat: add initial samples

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

packages/google-cloud-dataform/.repo-metadata.json

@@ -1,3 +1,14 @@
 {
-	"default_version": "v1alpha2"
-}
+	"name": "dataform",
+	"name_pretty": "Dataform API",
+	"product_documentation": "https://dataform.co/",
+	"client_documentation": "https://cloud.google.com/nodejs/docs/reference/dataform/latest",
+	"issue_tracker": "https://github.com/googleapis/nodejs-dataform/issues",
+	"release_level": "beta",
+	"language": "nodejs",
+	"repo": "googleapis/nodejs-dataform",
+	"distribution_name": "@google-cloud/dataform",
+	"api_id": "dataform.googleapis.com",
+	"default_version": "v1alpha2",
+	"requires_billing": true
+  }

packages/google-cloud-dataform/CONTRIBUTING.md

@@ -39,7 +39,9 @@ accept your pull requests.
 
 ### Before you begin
 
-1.  [Select or create a Cloud Platform project][projects]. 
+1.  [Select or create a Cloud Platform project][projects].
+1.  [Enable billing for your project][billing]. 
+1.  [Enable the Dataform API API][enable_api]. 
 1.  [Set up authentication with a service account][auth] so you can access the
     API from your local workstation.
 
@@ -70,5 +72,5 @@ accept your pull requests.
 [setup]: https://cloud.google.com/nodejs/docs/setup
 [projects]: https://console.cloud.google.com/project
 [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
-
+[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=dataform.googleapis.com
 [auth]: https://cloud.google.com/docs/authentication/getting-started

packages/google-cloud-dataform/README.md

@@ -2,9 +2,9 @@
 [//]: # "To regenerate it, use `python -m synthtool`."
 <img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
 
-# [:  Client](https://github.com/)
-
+# [Dataform API: Node.js Client](https://github.com/googleapis/nodejs-dataform)
 
+[![release level](https://img.shields.io/badge/release%20level-beta-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
 [![npm version](https://img.shields.io/npm/v/@google-cloud/dataform.svg)](https://www.npmjs.org/package/@google-cloud/dataform)
 
 
@@ -14,11 +14,11 @@ dataform client for Node.js
 
 
 A comprehensive list of changes in each version may be found in
-[the CHANGELOG](https://github.com//blob/master/CHANGELOG.md).
-
-
+[the CHANGELOG](https://github.com/googleapis/nodejs-dataform/blob/main/CHANGELOG.md).
 
-* [github.com/](https://github.com/)
+* [Dataform API Node.js Client API Reference][client-docs]
+* [Dataform API Documentation][product-docs]
+* [github.com/googleapis/nodejs-dataform](https://github.com/googleapis/nodejs-dataform)
 
 Read more about the client libraries for Cloud APIs, including the older
 Google APIs Client Libraries, in [Client Libraries Explained][explained].
@@ -29,7 +29,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 
 
 * [Quickstart](#quickstart)
-
+  * [Before you begin](#before-you-begin)
   * [Installing the client library](#installing-the-client-library)
 
 
@@ -39,6 +39,14 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 
 ## Quickstart
 
+### Before you begin
+
+1.  [Select or create a Cloud Platform project][projects].
+1.  [Enable billing for your project][billing].
+1.  [Enable the Dataform API API][enable_api].
+1.  [Set up authentication with a service account][auth] so you can access the
+    API from your local workstation.
+
 ### Installing the client library
 
 ```bash
@@ -49,6 +57,9 @@ npm install @google-cloud/dataform
 
 
 
+The [Dataform API Node.js Client API Reference][client-docs] documentation
+also contains samples.
+
 ## Supported Node.js Versions
 
 Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
@@ -77,6 +88,11 @@ This library follows [Semantic Versioning](http://semver.org/).
 
 
 
+This library is considered to be in **beta**. This means it is expected to be
+mostly stable while we work toward a general availability release; however,
+complete stability is not guaranteed. We will address issues and requests
+against beta libraries with a high priority.
+
 
 
 
@@ -87,7 +103,7 @@ More Information: [Google Cloud Platform Launch Stages][launch_stages]
 
 ## Contributing
 
-Contributions welcome! See the [Contributing Guide](https://github.com//blob/master/CONTRIBUTING.md).
+Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-dataform/blob/main/CONTRIBUTING.md).
 
 Please note that this `README.md`, the `samples/README.md`,
 and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
@@ -99,12 +115,12 @@ to its templates in
 
 Apache Version 2.0
 
-See [LICENSE](https://github.com//blob/master/LICENSE)
-
-
+See [LICENSE](https://github.com/googleapis/nodejs-dataform/blob/main/LICENSE)
 
+[client-docs]: https://cloud.google.com/nodejs/docs/reference/dataform/latest
+[product-docs]: https://dataform.co/
 [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
 [projects]: https://console.cloud.google.com/project
 [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
-
+[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=dataform.googleapis.com
 [auth]: https://cloud.google.com/docs/authentication/getting-started

packages/google-cloud-dataform/linkinator.config.json

@@ -1 +1,19 @@
-{"recurse":true,"skip":["https://codecov.io/gh/googleapis/","www.googleapis.com","img.shields.io"],"silent":true,"concurrency":5,"retry":true,"retryErrors":true,"retryErrorsCount":5,"retryErrorsJitter":3000}
+{
+  "recurse": true,
+  "skip": [
+    "https://codecov.io/gh/googleapis/",
+    "www.googleapis.com",
+    "img.shields.io",
+    "https://console.cloud.google.com/cloudshell",
+    "https://support.google.com",
+    "https://github.com/googleapis/nodejs-dataform/blob/master/CHANGELOG.md",
+    "https://cloud.google.com/nodejs/docs/reference/dataform/latest",
+    "https://github.com/googleapis/nodejs-dataform/blob/addSamples/CHANGELOG.md"
+  ],
+  "silent": true,
+  "concurrency": 5,
+  "retry": true,
+  "retryErrors": true,
+  "retryErrorsCount": 5,
+  "retryErrorsJitter": 3000
+}

packages/google-cloud-dataform/package.json

@@ -1 +1,66 @@
-{"name":"@google-cloud/dataform","version":"0.1.0","description":"dataform client for Node.js","repository":"googleapis/nodejs-dataform","license":"Apache-2.0","author":"Google LLC","main":"build/src/index.js","files":["build/src","build/protos"],"keywords":["google apis client","google api client","google apis","google api","google","google cloud platform","google cloud","cloud","google dataform","dataform","dataform service"],"scripts":{"clean":"gts clean","compile":"tsc -p . && cp -r protos build/","compile-protos":"compileProtos src","docs":"jsdoc -c .jsdoc.js","predocs-test":"npm run docs","docs-test":"linkinator docs","fix":"gts fix","lint":"gts check","prepare":"npm run compile-protos && npm run compile","system-test":"c8 mocha build/system-test","test":"c8 mocha build/test","samples-test":"cd samples/ && npm link ../ && npm test","prelint":"cd samples; npm link ../; npm i"},"dependencies":{"google-gax":"^2.12.0"},"devDependencies":{"@types/mocha":"^8.2.2","@types/node":"^14.14.44","@types/sinon":"^10.0.0","c8":"^7.7.2","gts":"^3.1.0","jsdoc":"^3.6.6","jsdoc-fresh":"^1.0.2","jsdoc-region-tag":"^1.0.6","linkinator":"^2.13.6","mocha":"^8.4.0","null-loader":"^4.0.1","pack-n-play":"^1.0.0-2","sinon":"^10.0.0","ts-loader":"^9.1.2","typescript":"^4.2.4","webpack":"^5.36.2","webpack-cli":"^4.7.0"},"engines":{"node":">=v12.0.0"}}
+{
+    "name": "@google-cloud/dataform",
+    "version": "0.1.0",
+    "description": "dataform client for Node.js",
+    "repository": "googleapis/nodejs-dataform",
+    "license": "Apache-2.0",
+    "author": "Google LLC",
+    "main": "build/src/index.js",
+    "files": [
+        "build/src",
+        "build/protos"
+    ],
+    "keywords": [
+        "google apis client",
+        "google api client",
+        "google apis",
+        "google api",
+        "google",
+        "google cloud platform",
+        "google cloud",
+        "cloud",
+        "google dataform",
+        "dataform",
+        "dataform service"
+    ],
+    "scripts": {
+        "clean": "gts clean",
+        "compile": "tsc -p . && cp -r protos build/",
+        "compile-protos": "compileProtos src",
+        "docs": "jsdoc -c .jsdoc.js",
+        "predocs-test": "npm run docs",
+        "docs-test": "linkinator docs",
+        "fix": "gts fix",
+        "lint": "gts check",
+        "prepare": "npm run compile-protos && npm run compile",
+        "system-test": "c8 mocha build/system-test",
+        "test": "c8 mocha build/test",
+        "samples-test": "cd samples/ && npm link ../ && npm test",
+        "prelint": "cd samples; npm link ../; npm i"
+    },
+    "dependencies": {
+        "google-gax": "^3.1.3"
+    },
+    "devDependencies": {
+        "@types/mocha": "^8.2.2",
+        "@types/node": "^14.14.44",
+        "@types/sinon": "^10.0.0",
+        "c8": "^7.7.2",
+        "gts": "^3.1.0",
+        "jsdoc": "^3.6.6",
+        "jsdoc-fresh": "^1.0.2",
+        "jsdoc-region-tag": "^1.0.6",
+        "linkinator": "^2.13.6",
+        "mocha": "^8.4.0",
+        "null-loader": "^4.0.1",
+        "pack-n-play": "^1.0.0-2",
+        "sinon": "^10.0.0",
+        "ts-loader": "^9.1.2",
+        "typescript": "^4.2.4",
+        "webpack": "^5.36.2",
+        "webpack-cli": "^4.7.0"
+    },
+    "engines": {
+        "node": ">=v12.0.0"
+    }
+}

packages/google-cloud-dataform/protos/google/cloud/dataform/v1alpha2/dataform.proto

@@ -421,6 +421,9 @@ message ListRepositoriesResponse {
   // A token which can be sent as `page_token` to retrieve the next page.
   // If this field is omitted, there are no subsequent pages.
   string next_page_token = 2;
+
+  // Locations which could not be reached.
+  repeated string unreachable = 3;
 }
 
 // `GetRepository` request message.
@@ -547,6 +550,9 @@ message ListWorkspacesResponse {
   // A token, which can be sent as `page_token` to retrieve the next page.
   // If this field is omitted, there are no subsequent pages.
   string next_page_token = 2;
+
+  // Locations which could not be reached.
+  repeated string unreachable = 3;
 }
 
 // `GetWorkspace` request message.
@@ -1084,6 +1090,9 @@ message ListCompilationResultsResponse {
   // A token, which can be sent as `page_token` to retrieve the next page.
   // If this field is omitted, there are no subsequent pages.
   string next_page_token = 2;
+
+  // Locations which could not be reached.
+  repeated string unreachable = 3;
 }
 
 // `GetCompilationResult` request message.
@@ -1474,6 +1483,9 @@ message ListWorkflowInvocationsResponse {
   // A token, which can be sent as `page_token` to retrieve the next page.
   // If this field is omitted, there are no subsequent pages.
   string next_page_token = 2;
+
+  // Locations which could not be reached.
+  repeated string unreachable = 3;
 }
 
 // `GetWorkflowInvocation` request message.
@@ -1567,6 +1579,9 @@ message WorkflowInvocationAction {
   // Output only. This action's current state.
   State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
 
+  // Output only. If and only if action's state is FAILED a failure reason is set.
+  string failure_reason = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Output only. This action's timing details.
   // `start_time` will be set if the action is in [RUNNING, SUCCEEDED,
   // CANCELLED, FAILED] state.