Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add comments for class level #64

Merged
merged 1 commit into from
Oct 21, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions templates/typescript_gapic/src/$version/$service_client.ts.njk
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,33 @@ export interface PaginationResponse<
}
{% endif %}
export class {{ service.name }}Client {
/**
* Construct an instance of {{ service.name }}Client.
*
* @@param {object} [options] - The configuration object. See the subsequent
* parameters for more details.
* @@param {object} [options.credentials] - Credentials object.
* @@param {string} [options.credentials.client_email]
* @@param {string} [options.credentials.private_key]
* @@param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @@param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @@param {number} [options.port] - The port on which to connect to
* the remote host.
* @@param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @@param {function} [options.promise] - Custom promise module to use instead
* of native Promises.
* @@param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
*/
private _descriptors: Descriptors = {page: {}, stream: {}, longrunning: {}};
private _innerApiCalls: {[name: string]: Function};
auth: gax.GoogleAuth;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,33 @@ export interface PaginationResponse<
}

export class KeyManagementServiceClient {
/**
* Construct an instance of KeyManagementServiceClient.
*
* @@param {object} [options] - The configuration object. See the subsequent
* parameters for more details.
* @@param {object} [options.credentials] - Credentials object.
* @@param {string} [options.credentials.client_email]
* @@param {string} [options.credentials.private_key]
* @@param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @@param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @@param {number} [options.port] - The port on which to connect to
* the remote host.
* @@param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @@param {function} [options.promise] - Custom promise module to use instead
* of native Promises.
* @@param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
*/
private _descriptors: Descriptors = {page: {}, stream: {}, longrunning: {}};
private _innerApiCalls: {[name: string]: Function};
auth: gax.GoogleAuth;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,33 @@ export interface PaginationResponse<
}

export class EchoClient {
/**
* Construct an instance of EchoClient.
*
* @@param {object} [options] - The configuration object. See the subsequent
* parameters for more details.
* @@param {object} [options.credentials] - Credentials object.
* @@param {string} [options.credentials.client_email]
* @@param {string} [options.credentials.private_key]
* @@param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @@param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @@param {number} [options.port] - The port on which to connect to
* the remote host.
* @@param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @@param {function} [options.promise] - Custom promise module to use instead
* of native Promises.
* @@param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
*/
private _descriptors: Descriptors = {page: {}, stream: {}, longrunning: {}};
private _innerApiCalls: {[name: string]: Function};
auth: gax.GoogleAuth;
Expand Down