Skip to content

Commit 7244cab

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: Trusted Private Cloud support, use the universeDomain parameter (#5025)
* feat: Trusted Private Cloud support, use the universeDomain parameter PiperOrigin-RevId: 604765466 Source-Link: googleapis/googleapis@40203ca Source-Link: googleapis/googleapis-gen@07b7f3d Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWVkZ2VuZXR3b3JrLy5Pd2xCb3QueWFtbCIsImgiOiIwN2I3ZjNkYWQ4YWExOTEyZDRhY2RjZmQ2MzY1YmI0MjM2ZTRiNTRiIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWVzc2VudGlhbGNvbnRhY3RzLy5Pd2xCb3QueWFtbCIsImgiOiIwN2I3ZjNkYWQ4YWExOTEyZDRhY2RjZmQ2MzY1YmI0MjM2ZTRiNTRiIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWV2ZW50YXJjLXB1Ymxpc2hpbmcvLk93bEJvdC55YW1sIiwiaCI6IjA3YjdmM2RhZDhhYTE5MTJkNGFjZGNmZDYzNjViYjQyMzZlNGI1NGIifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWV2ZW50YXJjLy5Pd2xCb3QueWFtbCIsImgiOiIwN2I3ZjNkYWQ4YWExOTEyZDRhY2RjZmQ2MzY1YmI0MjM2ZTRiNTRiIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWZpbGVzdG9yZS8uT3dsQm90LnlhbWwiLCJoIjoiMDdiN2YzZGFkOGFhMTkxMmQ0YWNkY2ZkNjM2NWJiNDIzNmU0YjU0YiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWZ1bmN0aW9ucy8uT3dsQm90LnlhbWwiLCJoIjoiMDdiN2YzZGFkOGFhMTkxMmQ0YWNkY2ZkNjM2NWJiNDIzNmU0YjU0YiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWdrZWJhY2t1cC8uT3dsQm90LnlhbWwiLCJoIjoiMDdiN2YzZGFkOGFhMTkxMmQ0YWNkY2ZkNjM2NWJiNDIzNmU0YjU0YiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWdrZWNvbm5lY3QtZ2F0ZXdheS8uT3dsQm90LnlhbWwiLCJoIjoiMDdiN2YzZGFkOGFhMTkxMmQ0YWNkY2ZkNjM2NWJiNDIzNmU0YjU0YiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWdrZWh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMDdiN2YzZGFkOGFhMTkxMmQ0YWNkY2ZkNjM2NWJiNDIzNmU0YjU0YiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWdrZW11bHRpY2xvdWQvLk93bEJvdC55YW1sIiwiaCI6IjA3YjdmM2RhZDhhYTE5MTJkNGFjZGNmZDYzNjViYjQyMzZlNGI1NGIifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWdzdWl0ZWFkZG9ucy8uT3dsQm90LnlhbWwiLCJoIjoiMDdiN2YzZGFkOGFhMTkxMmQ0YWNkY2ZkNjM2NWJiNDIzNmU0YjU0YiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWlhcC8uT3dsQm90LnlhbWwiLCJoIjoiMDdiN2YzZGFkOGFhMTkxMmQ0YWNkY2ZkNjM2NWJiNDIzNmU0YjU0YiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWlkcy8uT3dsQm90LnlhbWwiLCJoIjoiMDdiN2YzZGFkOGFhMTkxMmQ0YWNkY2ZkNjM2NWJiNDIzNmU0YjU0YiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWlvdC8uT3dsQm90LnlhbWwiLCJoIjoiMDdiN2YzZGFkOGFhMTkxMmQ0YWNkY2ZkNjM2NWJiNDIzNmU0YjU0YiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWttcy1pbnZlbnRvcnkvLk93bEJvdC55YW1sIiwiaCI6IjA3YjdmM2RhZDhhYTE5MTJkNGFjZGNmZDYzNjViYjQyMzZlNGI1NGIifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWttcy8uT3dsQm90LnlhbWwiLCJoIjoiMDdiN2YzZGFkOGFhMTkxMmQ0YWNkY2ZkNjM2NWJiNDIzNmU0YjU0YiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWxhbmd1YWdlLy5Pd2xCb3QueWFtbCIsImgiOiIwN2I3ZjNkYWQ4YWExOTEyZDRhY2RjZmQ2MzY1YmI0MjM2ZTRiNTRiIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWxpZmVzY2llbmNlcy8uT3dsQm90LnlhbWwiLCJoIjoiMDdiN2YzZGFkOGFhMTkxMmQ0YWNkY2ZkNjM2NWJiNDIzNmU0YjU0YiJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLW1hbmFnZWRpZGVudGl0aWVzLy5Pd2xCb3QueWFtbCIsImgiOiIwN2I3ZjNkYWQ4YWExOTEyZDRhY2RjZmQ2MzY1YmI0MjM2ZTRiNTRiIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLW1lZGlhdHJhbnNsYXRpb24vLk93bEJvdC55YW1sIiwiaCI6IjA3YjdmM2RhZDhhYTE5MTJkNGFjZGNmZDYzNjViYjQyMzZlNGI1NGIifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 6b999a0 commit 7244cab

131 files changed

Lines changed: 4032 additions & 572 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎packages/google-cloud-edgenetwork/samples/generated/v1/edge_network.list_interconnect_attachments.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ function main(parent) {
6363
};
6464

6565
// Run request
66-
const iterable = await edgenetworkClient.listInterconnectAttachmentsAsync(request);
66+
const iterable = edgenetworkClient.listInterconnectAttachmentsAsync(request);
6767
for await (const response of iterable) {
6868
console.log(response);
6969
}

‎packages/google-cloud-edgenetwork/samples/generated/v1/edge_network.list_interconnects.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ function main(parent) {
6363
};
6464

6565
// Run request
66-
const iterable = await edgenetworkClient.listInterconnectsAsync(request);
66+
const iterable = edgenetworkClient.listInterconnectsAsync(request);
6767
for await (const response of iterable) {
6868
console.log(response);
6969
}

‎packages/google-cloud-edgenetwork/samples/generated/v1/edge_network.list_networks.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ function main(parent) {
6363
};
6464

6565
// Run request
66-
const iterable = await edgenetworkClient.listNetworksAsync(request);
66+
const iterable = edgenetworkClient.listNetworksAsync(request);
6767
for await (const response of iterable) {
6868
console.log(response);
6969
}

‎packages/google-cloud-edgenetwork/samples/generated/v1/edge_network.list_routers.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ function main(parent) {
6363
};
6464

6565
// Run request
66-
const iterable = await edgenetworkClient.listRoutersAsync(request);
66+
const iterable = edgenetworkClient.listRoutersAsync(request);
6767
for await (const response of iterable) {
6868
console.log(response);
6969
}

‎packages/google-cloud-edgenetwork/samples/generated/v1/edge_network.list_subnets.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ function main(parent) {
6363
};
6464

6565
// Run request
66-
const iterable = await edgenetworkClient.listSubnetsAsync(request);
66+
const iterable = edgenetworkClient.listSubnetsAsync(request);
6767
for await (const response of iterable) {
6868
console.log(response);
6969
}

‎packages/google-cloud-edgenetwork/samples/generated/v1/edge_network.list_zones.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ function main(parent) {
6363
};
6464

6565
// Run request
66-
const iterable = await edgenetworkClient.listZonesAsync(request);
66+
const iterable = edgenetworkClient.listZonesAsync(request);
6767
for await (const response of iterable) {
6868
console.log(response);
6969
}

‎packages/google-cloud-edgenetwork/src/v1/edge_network_client.ts‎

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ import type {
3333
import {Transform} from 'stream';
3434
import * as protos from '../../protos/protos';
3535
import jsonProtos = require('../../protos/protos.json');
36+
3637
/**
3738
* Client JSON configuration object, loaded from
3839
* `src/v1/edge_network_client_config.json`.
@@ -57,6 +58,8 @@ export class EdgeNetworkClient {
5758
private _gaxGrpc: gax.GrpcClient | gax.fallback.GrpcClient;
5859
private _protos: {};
5960
private _defaults: {[method: string]: gax.CallSettings};
61+
private _universeDomain: string;
62+
private _servicePath: string;
6063
auth: gax.GoogleAuth;
6164
descriptors: Descriptors = {
6265
page: {},
@@ -116,8 +119,20 @@ export class EdgeNetworkClient {
116119
) {
117120
// Ensure that options include all the required fields.
118121
const staticMembers = this.constructor as typeof EdgeNetworkClient;
122+
if (
123+
opts?.universe_domain &&
124+
opts?.universeDomain &&
125+
opts?.universe_domain !== opts?.universeDomain
126+
) {
127+
throw new Error(
128+
'Please set either universe_domain or universeDomain, but not both.'
129+
);
130+
}
131+
this._universeDomain =
132+
opts?.universeDomain ?? opts?.universe_domain ?? 'googleapis.com';
133+
this._servicePath = 'edgenetwork.' + this._universeDomain;
119134
const servicePath =
120-
opts?.servicePath || opts?.apiEndpoint || staticMembers.servicePath;
135+
opts?.servicePath || opts?.apiEndpoint || this._servicePath;
121136
this._providedCustomServicePath = !!(
122137
opts?.servicePath || opts?.apiEndpoint
123138
);
@@ -132,7 +147,7 @@ export class EdgeNetworkClient {
132147
opts.numericEnums = true;
133148

134149
// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
135-
if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
150+
if (servicePath !== this._servicePath && !('scopes' in opts)) {
136151
opts['scopes'] = staticMembers.scopes;
137152
}
138153

@@ -157,10 +172,10 @@ export class EdgeNetworkClient {
157172
this.auth.useJWTAccessWithScope = true;
158173

159174
// Set defaultServicePath on the auth object.
160-
this.auth.defaultServicePath = staticMembers.servicePath;
175+
this.auth.defaultServicePath = this._servicePath;
161176

162177
// Set the default scopes in auth client if needed.
163-
if (servicePath === staticMembers.servicePath) {
178+
if (servicePath === this._servicePath) {
164179
this.auth.defaultScopes = staticMembers.scopes;
165180
}
166181
this.locationsClient = new this._gaxModule.LocationsClient(
@@ -526,21 +541,52 @@ export class EdgeNetworkClient {
526541

527542
/**
528543
* The DNS address for this API service.
544+
* @deprecated Use the apiEndpoint method of the client instance.
529545
* @returns {string} The DNS address for this service.
530546
*/
531547
static get servicePath() {
548+
if (
549+
typeof process !== undefined &&
550+
typeof process.emitWarning === 'function'
551+
) {
552+
process.emitWarning(
553+
'Static servicePath is deprecated, please use the instance method instead.',
554+
'DeprecationWarning'
555+
);
556+
}
532557
return 'edgenetwork.googleapis.com';
533558
}
534559

535560
/**
536-
* The DNS address for this API service - same as servicePath(),
537-
* exists for compatibility reasons.
561+
* The DNS address for this API service - same as servicePath.
562+
* @deprecated Use the apiEndpoint method of the client instance.
538563
* @returns {string} The DNS address for this service.
539564
*/
540565
static get apiEndpoint() {
566+
if (
567+
typeof process !== undefined &&
568+
typeof process.emitWarning === 'function'
569+
) {
570+
process.emitWarning(
571+
'Static apiEndpoint is deprecated, please use the instance method instead.',
572+
'DeprecationWarning'
573+
);
574+
}
541575
return 'edgenetwork.googleapis.com';
542576
}
543577

578+
/**
579+
* The DNS address for this API service.
580+
* @returns {string} The DNS address for this service.
581+
*/
582+
get apiEndpoint() {
583+
return this._servicePath;
584+
}
585+
586+
get universeDomain() {
587+
return this._universeDomain;
588+
}
589+
544590
/**
545591
* The port for this API service.
546592
* @returns {number} The default port for this service.

‎packages/google-cloud-edgenetwork/test/gapic_edge_network_v1.ts‎

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -166,14 +166,60 @@ function stubAsyncIterationCall<ResponseType>(
166166

167167
describe('v1.EdgeNetworkClient', () => {
168168
describe('Common methods', () => {
169-
it('has servicePath', () => {
170-
const servicePath = edgenetworkModule.v1.EdgeNetworkClient.servicePath;
171-
assert(servicePath);
169+
it('has apiEndpoint', () => {
170+
const client = new edgenetworkModule.v1.EdgeNetworkClient();
171+
const apiEndpoint = client.apiEndpoint;
172+
assert.strictEqual(apiEndpoint, 'edgenetwork.googleapis.com');
172173
});
173174

174-
it('has apiEndpoint', () => {
175-
const apiEndpoint = edgenetworkModule.v1.EdgeNetworkClient.apiEndpoint;
176-
assert(apiEndpoint);
175+
it('has universeDomain', () => {
176+
const client = new edgenetworkModule.v1.EdgeNetworkClient();
177+
const universeDomain = client.universeDomain;
178+
assert.strictEqual(universeDomain, 'googleapis.com');
179+
});
180+
181+
if (
182+
typeof process !== 'undefined' &&
183+
typeof process.emitWarning === 'function'
184+
) {
185+
it('throws DeprecationWarning if static servicePath is used', () => {
186+
const stub = sinon.stub(process, 'emitWarning');
187+
const servicePath = edgenetworkModule.v1.EdgeNetworkClient.servicePath;
188+
assert.strictEqual(servicePath, 'edgenetwork.googleapis.com');
189+
assert(stub.called);
190+
stub.restore();
191+
});
192+
193+
it('throws DeprecationWarning if static apiEndpoint is used', () => {
194+
const stub = sinon.stub(process, 'emitWarning');
195+
const apiEndpoint = edgenetworkModule.v1.EdgeNetworkClient.apiEndpoint;
196+
assert.strictEqual(apiEndpoint, 'edgenetwork.googleapis.com');
197+
assert(stub.called);
198+
stub.restore();
199+
});
200+
}
201+
it('sets apiEndpoint according to universe domain camelCase', () => {
202+
const client = new edgenetworkModule.v1.EdgeNetworkClient({
203+
universeDomain: 'example.com',
204+
});
205+
const servicePath = client.apiEndpoint;
206+
assert.strictEqual(servicePath, 'edgenetwork.example.com');
207+
});
208+
209+
it('sets apiEndpoint according to universe domain snakeCase', () => {
210+
const client = new edgenetworkModule.v1.EdgeNetworkClient({
211+
universe_domain: 'example.com',
212+
});
213+
const servicePath = client.apiEndpoint;
214+
assert.strictEqual(servicePath, 'edgenetwork.example.com');
215+
});
216+
it('does not allow setting both universeDomain and universe_domain', () => {
217+
assert.throws(() => {
218+
new edgenetworkModule.v1.EdgeNetworkClient({
219+
universe_domain: 'example.com',
220+
universeDomain: 'example.net',
221+
});
222+
});
177223
});
178224

179225
it('has port', () => {

‎packages/google-cloud-essentialcontacts/samples/generated/v1/essential_contacts_service.compute_contacts.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ function main(parent) {
6868
};
6969

7070
// Run request
71-
const iterable = await essentialcontactsClient.computeContactsAsync(request);
71+
const iterable = essentialcontactsClient.computeContactsAsync(request);
7272
for await (const response of iterable) {
7373
console.log(response);
7474
}

‎packages/google-cloud-essentialcontacts/samples/generated/v1/essential_contacts_service.list_contacts.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ function main(parent) {
6262
};
6363

6464
// Run request
65-
const iterable = await essentialcontactsClient.listContactsAsync(request);
65+
const iterable = essentialcontactsClient.listContactsAsync(request);
6666
for await (const response of iterable) {
6767
console.log(response);
6868
}

0 commit comments

Comments
 (0)