diff --git a/packages/google-cloud-compute/README.md b/packages/google-cloud-compute/README.md index 0b78b7b22331..45d601143baa 100644 --- a/packages/google-cloud-compute/README.md +++ b/packages/google-cloud-compute/README.md @@ -642,6 +642,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/ | Resource_policies.get_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-compute/samples/generated/v1/resource_policies.get_iam_policy.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-compute/samples/generated/v1/resource_policies.get_iam_policy.js,packages/google-cloud-compute/samples/README.md) | | Resource_policies.insert | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-compute/samples/generated/v1/resource_policies.insert.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-compute/samples/generated/v1/resource_policies.insert.js,packages/google-cloud-compute/samples/README.md) | | Resource_policies.list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-compute/samples/generated/v1/resource_policies.list.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-compute/samples/generated/v1/resource_policies.list.js,packages/google-cloud-compute/samples/README.md) | +| Resource_policies.patch | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-compute/samples/generated/v1/resource_policies.patch.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-compute/samples/generated/v1/resource_policies.patch.js,packages/google-cloud-compute/samples/README.md) | | Resource_policies.set_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-compute/samples/generated/v1/resource_policies.set_iam_policy.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-compute/samples/generated/v1/resource_policies.set_iam_policy.js,packages/google-cloud-compute/samples/README.md) | | Resource_policies.test_iam_permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-compute/samples/generated/v1/resource_policies.test_iam_permissions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-compute/samples/generated/v1/resource_policies.test_iam_permissions.js,packages/google-cloud-compute/samples/README.md) | | Routers.aggregated_list | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-compute/samples/generated/v1/routers.aggregated_list.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-compute/samples/generated/v1/routers.aggregated_list.js,packages/google-cloud-compute/samples/README.md) | diff --git a/packages/google-cloud-compute/protos/google/cloud/compute/v1/compute.proto b/packages/google-cloud-compute/protos/google/cloud/compute/v1/compute.proto index a6b46343f81a..ea8ac4ac885b 100644 --- a/packages/google-cloud-compute/protos/google/cloud/compute/v1/compute.proto +++ b/packages/google-cloud-compute/protos/google/cloud/compute/v1/compute.proto @@ -14,7 +14,7 @@ // Generated by the disco-to-proto3-converter. DO NOT EDIT! // Source Discovery file: compute.v1.json -// Source file revision: 20230701 +// Source file revision: 20230711 // API name: compute // API version: v1 @@ -2887,7 +2887,7 @@ message BackendBucket { // [Output Only] Creation timestamp in RFC3339 text format. optional string creation_timestamp = 30525366; - // Headers that the HTTP/S load balancer should add to proxied responses. + // Headers that the Application Load Balancer should add to proxied responses. repeated string custom_response_headers = 387539094; // An optional textual description of the resource; provided by the client when the resource is created. @@ -6854,6 +6854,9 @@ message DistributionPolicy { // The group picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability. ANY = 64972; + // The group creates all VM instances within a single zone. The zone is selected based on the present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads with heavy interprocess communication. + ANY_SINGLE_ZONE = 61100880; + // The group prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across selected zones to minimize the impact of zonal failure. Recommended for highly available serving workloads. BALANCED = 468409608; @@ -12714,14 +12717,14 @@ message InstanceGroupManagerUpdatePolicy { } - // The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). + // The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update. // Additional supported values which may be not listed in the enum directly due to technical reasons: // PROACTIVE enum Type { // A value indicating that the enum field is not set. UNDEFINED_TYPE = 0; - // No action is being proactively performed in order to bring this IGM to its target version distribution (regardless of whether this distribution is expressed using instanceTemplate or versions field). + // MIG will apply new configurations to existing VMs only when you selectively target specific or all VMs to be updated. OPPORTUNISTIC = 429530089; } @@ -12748,7 +12751,7 @@ message InstanceGroupManagerUpdatePolicy { // Check the ReplacementMethod enum for the list of possible values. optional string replacement_method = 505931694; - // The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). + // The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update. // Check the Type enum for the list of possible values. optional string type = 3575610; @@ -20746,6 +20749,34 @@ message PatchRegionUrlMapRequest { } +// A request message for ResourcePolicies.Patch. See the method description for details. +message PatchResourcePolicyRequest { + // Project ID for this request. + string project = 227560217 [ + (google.api.field_behavior) = REQUIRED, + (google.cloud.operation_request_field) = "project" + ]; + + // Name of the region for this request. + string region = 138946292 [ + (google.api.field_behavior) = REQUIRED, + (google.cloud.operation_request_field) = "region" + ]; + + // An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + optional string request_id = 37109963; + + // Id of the resource policy to patch. + string resource_policy = 159240835 [(google.api.field_behavior) = REQUIRED]; + + // The body resource for this request + ResourcePolicy resource_policy_resource = 76826186 [(google.api.field_behavior) = REQUIRED]; + + // update_mask indicates fields to be updated as part of this request. + optional string update_mask = 500079778; + +} + // A request message for Routers.Patch. See the method description for details. message PatchRouterRequest { // Project ID for this request. @@ -21953,9 +21984,25 @@ message Quota { // Additional details for quota exceeded error for resource quota. message QuotaExceededInfo { + // Rollout status of the future quota limit. + enum RolloutStatus { + // A value indicating that the enum field is not set. + UNDEFINED_ROLLOUT_STATUS = 0; + + // IN_PROGRESS - A rollout is in process which will change the limit value to future limit. + IN_PROGRESS = 469193735; + + // ROLLOUT_STATUS_UNSPECIFIED - Rollout status is not specified. The default value. + ROLLOUT_STATUS_UNSPECIFIED = 26864568; + + } + // The map holding related quota dimensions. map dimensions = 414334925; + // Future quota limit being rolled out. The limit's unit depends on the quota type or metric. + optional double future_limit = 456564287; + // Current effective quota limit. The limit's unit depends on the quota type or metric. optional double limit = 102976443; @@ -21965,6 +22012,10 @@ message QuotaExceededInfo { // The Compute Engine quota metric name. optional string metric_name = 409881530; + // Rollout status of the future quota limit. + // Check the RolloutStatus enum for the list of possible values. + optional string rollout_status = 476426816; + } // The parameters of the raw disk image. @@ -24764,6 +24815,9 @@ message Scheduling { // Check the InstanceTerminationAction enum for the list of possible values. optional string instance_termination_action = 107380667; + // Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. + optional Duration local_ssd_recovery_timeout = 268015590; + // An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API. optional string location_hint = 350519505; @@ -25537,6 +25591,9 @@ message ServiceAttachmentConnectedEndpoint { } + // The url of the consumer network. + optional string consumer_network = 254357221; + // The url of a connected endpoint. optional string endpoint = 130489749; @@ -36833,7 +36890,7 @@ service RegionSecurityPolicies { option (google.api.method_signature) = "project,region"; } - // Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. + // Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. rpc Patch(PatchRegionSecurityPolicyRequest) returns (Operation) { option (google.api.http) = { body: "security_policy_resource" @@ -37396,6 +37453,16 @@ service ResourcePolicies { option (google.api.method_signature) = "project,region"; } + // Modify the specified resource policy. + rpc Patch(PatchResourcePolicyRequest) returns (Operation) { + option (google.api.http) = { + body: "resource_policy_resource" + patch: "/compute/v1/projects/{project}/regions/{region}/resourcePolicies/{resource_policy}" + }; + option (google.api.method_signature) = "project,region,resource_policy,resource_policy_resource"; + option (google.cloud.operation_service) = "RegionOperations"; + } + // Sets the access control policy on the specified resource. Replaces any existing policy. rpc SetIamPolicy(SetIamPolicyResourcePolicyRequest) returns (Policy) { option (google.api.http) = { @@ -37639,7 +37706,7 @@ service SecurityPolicies { option (google.api.method_signature) = "project"; } - // Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. + // Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. rpc Patch(PatchSecurityPolicyRequest) returns (Operation) { option (google.api.http) = { body: "security_policy_resource" @@ -37649,7 +37716,7 @@ service SecurityPolicies { option (google.cloud.operation_service) = "GlobalOperations"; } - // Patches a rule at the specified priority. + // Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask. rpc PatchRule(PatchRuleSecurityPolicyRequest) returns (Operation) { option (google.api.http) = { body: "security_policy_rule_resource" diff --git a/packages/google-cloud-compute/protos/protos.d.ts b/packages/google-cloud-compute/protos/protos.d.ts index a3d90fd65970..aa2bef837f6f 100644 --- a/packages/google-cloud-compute/protos/protos.d.ts +++ b/packages/google-cloud-compute/protos/protos.d.ts @@ -36310,6 +36310,7 @@ export namespace google { enum TargetShape { UNDEFINED_TARGET_SHAPE = 0, ANY = 64972, + ANY_SINGLE_ZONE = 61100880, BALANCED = 468409608, EVEN = 2140442 } @@ -117415,6 +117416,139 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of a PatchResourcePolicyRequest. */ + interface IPatchResourcePolicyRequest { + + /** PatchResourcePolicyRequest project */ + project?: (string|null); + + /** PatchResourcePolicyRequest region */ + region?: (string|null); + + /** PatchResourcePolicyRequest requestId */ + requestId?: (string|null); + + /** PatchResourcePolicyRequest resourcePolicy */ + resourcePolicy?: (string|null); + + /** PatchResourcePolicyRequest resourcePolicyResource */ + resourcePolicyResource?: (google.cloud.compute.v1.IResourcePolicy|null); + + /** PatchResourcePolicyRequest updateMask */ + updateMask?: (string|null); + } + + /** Represents a PatchResourcePolicyRequest. */ + class PatchResourcePolicyRequest implements IPatchResourcePolicyRequest { + + /** + * Constructs a new PatchResourcePolicyRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.compute.v1.IPatchResourcePolicyRequest); + + /** PatchResourcePolicyRequest project. */ + public project: string; + + /** PatchResourcePolicyRequest region. */ + public region: string; + + /** PatchResourcePolicyRequest requestId. */ + public requestId?: (string|null); + + /** PatchResourcePolicyRequest resourcePolicy. */ + public resourcePolicy: string; + + /** PatchResourcePolicyRequest resourcePolicyResource. */ + public resourcePolicyResource?: (google.cloud.compute.v1.IResourcePolicy|null); + + /** PatchResourcePolicyRequest updateMask. */ + public updateMask?: (string|null); + + /** PatchResourcePolicyRequest _requestId. */ + public _requestId?: "requestId"; + + /** PatchResourcePolicyRequest _updateMask. */ + public _updateMask?: "updateMask"; + + /** + * Creates a new PatchResourcePolicyRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns PatchResourcePolicyRequest instance + */ + public static create(properties?: google.cloud.compute.v1.IPatchResourcePolicyRequest): google.cloud.compute.v1.PatchResourcePolicyRequest; + + /** + * Encodes the specified PatchResourcePolicyRequest message. Does not implicitly {@link google.cloud.compute.v1.PatchResourcePolicyRequest.verify|verify} messages. + * @param message PatchResourcePolicyRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.compute.v1.IPatchResourcePolicyRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified PatchResourcePolicyRequest message, length delimited. Does not implicitly {@link google.cloud.compute.v1.PatchResourcePolicyRequest.verify|verify} messages. + * @param message PatchResourcePolicyRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.compute.v1.IPatchResourcePolicyRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a PatchResourcePolicyRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns PatchResourcePolicyRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.PatchResourcePolicyRequest; + + /** + * Decodes a PatchResourcePolicyRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns PatchResourcePolicyRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.PatchResourcePolicyRequest; + + /** + * Verifies a PatchResourcePolicyRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a PatchResourcePolicyRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns PatchResourcePolicyRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.PatchResourcePolicyRequest; + + /** + * Creates a plain object from a PatchResourcePolicyRequest message. Also converts values to other types if specified. + * @param message PatchResourcePolicyRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.compute.v1.PatchResourcePolicyRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this PatchResourcePolicyRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for PatchResourcePolicyRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + /** Properties of a PatchRouterRequest. */ interface IPatchRouterRequest { @@ -122342,6 +122476,9 @@ export namespace google { /** QuotaExceededInfo dimensions */ dimensions?: ({ [k: string]: string }|null); + /** QuotaExceededInfo futureLimit */ + futureLimit?: (number|null); + /** QuotaExceededInfo limit */ limit?: (number|null); @@ -122350,6 +122487,9 @@ export namespace google { /** QuotaExceededInfo metricName */ metricName?: (string|null); + + /** QuotaExceededInfo rolloutStatus */ + rolloutStatus?: (string|null); } /** Represents a QuotaExceededInfo. */ @@ -122364,6 +122504,9 @@ export namespace google { /** QuotaExceededInfo dimensions. */ public dimensions: { [k: string]: string }; + /** QuotaExceededInfo futureLimit. */ + public futureLimit?: (number|null); + /** QuotaExceededInfo limit. */ public limit?: (number|null); @@ -122373,6 +122516,12 @@ export namespace google { /** QuotaExceededInfo metricName. */ public metricName?: (string|null); + /** QuotaExceededInfo rolloutStatus. */ + public rolloutStatus?: (string|null); + + /** QuotaExceededInfo _futureLimit. */ + public _futureLimit?: "futureLimit"; + /** QuotaExceededInfo _limit. */ public _limit?: "limit"; @@ -122382,6 +122531,9 @@ export namespace google { /** QuotaExceededInfo _metricName. */ public _metricName?: "metricName"; + /** QuotaExceededInfo _rolloutStatus. */ + public _rolloutStatus?: "rolloutStatus"; + /** * Creates a new QuotaExceededInfo instance using the specified properties. * @param [properties] Properties to set @@ -122460,6 +122612,16 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + namespace QuotaExceededInfo { + + /** RolloutStatus enum. */ + enum RolloutStatus { + UNDEFINED_ROLLOUT_STATUS = 0, + IN_PROGRESS = 469193735, + ROLLOUT_STATUS_UNSPECIFIED = 26864568 + } + } + /** Properties of a RawDisk. */ interface IRawDisk { @@ -137559,6 +137721,9 @@ export namespace google { /** Scheduling instanceTerminationAction */ instanceTerminationAction?: (string|null); + /** Scheduling localSsdRecoveryTimeout */ + localSsdRecoveryTimeout?: (google.cloud.compute.v1.IDuration|null); + /** Scheduling locationHint */ locationHint?: (string|null); @@ -137593,6 +137758,9 @@ export namespace google { /** Scheduling instanceTerminationAction. */ public instanceTerminationAction?: (string|null); + /** Scheduling localSsdRecoveryTimeout. */ + public localSsdRecoveryTimeout?: (google.cloud.compute.v1.IDuration|null); + /** Scheduling locationHint. */ public locationHint?: (string|null); @@ -137617,6 +137785,9 @@ export namespace google { /** Scheduling _instanceTerminationAction. */ public _instanceTerminationAction?: "instanceTerminationAction"; + /** Scheduling _localSsdRecoveryTimeout. */ + public _localSsdRecoveryTimeout?: "localSsdRecoveryTimeout"; + /** Scheduling _locationHint. */ public _locationHint?: "locationHint"; @@ -142233,6 +142404,9 @@ export namespace google { /** Properties of a ServiceAttachmentConnectedEndpoint. */ interface IServiceAttachmentConnectedEndpoint { + /** ServiceAttachmentConnectedEndpoint consumerNetwork */ + consumerNetwork?: (string|null); + /** ServiceAttachmentConnectedEndpoint endpoint */ endpoint?: (string|null); @@ -142252,6 +142426,9 @@ export namespace google { */ constructor(properties?: google.cloud.compute.v1.IServiceAttachmentConnectedEndpoint); + /** ServiceAttachmentConnectedEndpoint consumerNetwork. */ + public consumerNetwork?: (string|null); + /** ServiceAttachmentConnectedEndpoint endpoint. */ public endpoint?: (string|null); @@ -142261,6 +142438,9 @@ export namespace google { /** ServiceAttachmentConnectedEndpoint status. */ public status?: (string|null); + /** ServiceAttachmentConnectedEndpoint _consumerNetwork. */ + public _consumerNetwork?: "consumerNetwork"; + /** ServiceAttachmentConnectedEndpoint _endpoint. */ public _endpoint?: "endpoint"; @@ -190295,6 +190475,20 @@ export namespace google { */ public list(request: google.cloud.compute.v1.IListResourcePoliciesRequest): Promise; + /** + * Calls Patch. + * @param request PatchResourcePolicyRequest message or plain object + * @param callback Node-style callback called with the error, if any, and Operation + */ + public patch(request: google.cloud.compute.v1.IPatchResourcePolicyRequest, callback: google.cloud.compute.v1.ResourcePolicies.PatchCallback): void; + + /** + * Calls Patch. + * @param request PatchResourcePolicyRequest message or plain object + * @returns Promise + */ + public patch(request: google.cloud.compute.v1.IPatchResourcePolicyRequest): Promise; + /** * Calls SetIamPolicy. * @param request SetIamPolicyResourcePolicyRequest message or plain object @@ -190368,6 +190562,13 @@ export namespace google { */ type ListCallback = (error: (Error|null), response?: google.cloud.compute.v1.ResourcePolicyList) => void; + /** + * Callback as used by {@link google.cloud.compute.v1.ResourcePolicies|patch}. + * @param error Error, if any + * @param [response] Operation + */ + type PatchCallback = (error: (Error|null), response?: google.cloud.compute.v1.Operation) => void; + /** * Callback as used by {@link google.cloud.compute.v1.ResourcePolicies|setIamPolicy}. * @param error Error, if any diff --git a/packages/google-cloud-compute/protos/protos.js b/packages/google-cloud-compute/protos/protos.js index a0b926f86f90..8f4f99751ea3 100644 --- a/packages/google-cloud-compute/protos/protos.js +++ b/packages/google-cloud-compute/protos/protos.js @@ -98735,6 +98735,7 @@ * @enum {number} * @property {number} UNDEFINED_TARGET_SHAPE=0 UNDEFINED_TARGET_SHAPE value * @property {number} ANY=64972 ANY value + * @property {number} ANY_SINGLE_ZONE=61100880 ANY_SINGLE_ZONE value * @property {number} BALANCED=468409608 BALANCED value * @property {number} EVEN=2140442 EVEN value */ @@ -98742,6 +98743,7 @@ var valuesById = {}, values = Object.create(valuesById); values[valuesById[0] = "UNDEFINED_TARGET_SHAPE"] = 0; values[valuesById[64972] = "ANY"] = 64972; + values[valuesById[61100880] = "ANY_SINGLE_ZONE"] = 61100880; values[valuesById[468409608] = "BALANCED"] = 468409608; values[valuesById[2140442] = "EVEN"] = 2140442; return values; @@ -318989,6 +318991,364 @@ return PatchRegionUrlMapRequest; })(); + v1.PatchResourcePolicyRequest = (function() { + + /** + * Properties of a PatchResourcePolicyRequest. + * @memberof google.cloud.compute.v1 + * @interface IPatchResourcePolicyRequest + * @property {string|null} [project] PatchResourcePolicyRequest project + * @property {string|null} [region] PatchResourcePolicyRequest region + * @property {string|null} [requestId] PatchResourcePolicyRequest requestId + * @property {string|null} [resourcePolicy] PatchResourcePolicyRequest resourcePolicy + * @property {google.cloud.compute.v1.IResourcePolicy|null} [resourcePolicyResource] PatchResourcePolicyRequest resourcePolicyResource + * @property {string|null} [updateMask] PatchResourcePolicyRequest updateMask + */ + + /** + * Constructs a new PatchResourcePolicyRequest. + * @memberof google.cloud.compute.v1 + * @classdesc Represents a PatchResourcePolicyRequest. + * @implements IPatchResourcePolicyRequest + * @constructor + * @param {google.cloud.compute.v1.IPatchResourcePolicyRequest=} [properties] Properties to set + */ + function PatchResourcePolicyRequest(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * PatchResourcePolicyRequest project. + * @member {string} project + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @instance + */ + PatchResourcePolicyRequest.prototype.project = ""; + + /** + * PatchResourcePolicyRequest region. + * @member {string} region + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @instance + */ + PatchResourcePolicyRequest.prototype.region = ""; + + /** + * PatchResourcePolicyRequest requestId. + * @member {string|null|undefined} requestId + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @instance + */ + PatchResourcePolicyRequest.prototype.requestId = null; + + /** + * PatchResourcePolicyRequest resourcePolicy. + * @member {string} resourcePolicy + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @instance + */ + PatchResourcePolicyRequest.prototype.resourcePolicy = ""; + + /** + * PatchResourcePolicyRequest resourcePolicyResource. + * @member {google.cloud.compute.v1.IResourcePolicy|null|undefined} resourcePolicyResource + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @instance + */ + PatchResourcePolicyRequest.prototype.resourcePolicyResource = null; + + /** + * PatchResourcePolicyRequest updateMask. + * @member {string|null|undefined} updateMask + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @instance + */ + PatchResourcePolicyRequest.prototype.updateMask = null; + + // OneOf field names bound to virtual getters and setters + var $oneOfFields; + + /** + * PatchResourcePolicyRequest _requestId. + * @member {"requestId"|undefined} _requestId + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @instance + */ + Object.defineProperty(PatchResourcePolicyRequest.prototype, "_requestId", { + get: $util.oneOfGetter($oneOfFields = ["requestId"]), + set: $util.oneOfSetter($oneOfFields) + }); + + /** + * PatchResourcePolicyRequest _updateMask. + * @member {"updateMask"|undefined} _updateMask + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @instance + */ + Object.defineProperty(PatchResourcePolicyRequest.prototype, "_updateMask", { + get: $util.oneOfGetter($oneOfFields = ["updateMask"]), + set: $util.oneOfSetter($oneOfFields) + }); + + /** + * Creates a new PatchResourcePolicyRequest instance using the specified properties. + * @function create + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @static + * @param {google.cloud.compute.v1.IPatchResourcePolicyRequest=} [properties] Properties to set + * @returns {google.cloud.compute.v1.PatchResourcePolicyRequest} PatchResourcePolicyRequest instance + */ + PatchResourcePolicyRequest.create = function create(properties) { + return new PatchResourcePolicyRequest(properties); + }; + + /** + * Encodes the specified PatchResourcePolicyRequest message. Does not implicitly {@link google.cloud.compute.v1.PatchResourcePolicyRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @static + * @param {google.cloud.compute.v1.IPatchResourcePolicyRequest} message PatchResourcePolicyRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PatchResourcePolicyRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.requestId != null && Object.hasOwnProperty.call(message, "requestId")) + writer.uint32(/* id 37109963, wireType 2 =*/296879706).string(message.requestId); + if (message.resourcePolicyResource != null && Object.hasOwnProperty.call(message, "resourcePolicyResource")) + $root.google.cloud.compute.v1.ResourcePolicy.encode(message.resourcePolicyResource, writer.uint32(/* id 76826186, wireType 2 =*/614609490).fork()).ldelim(); + if (message.region != null && Object.hasOwnProperty.call(message, "region")) + writer.uint32(/* id 138946292, wireType 2 =*/1111570338).string(message.region); + if (message.resourcePolicy != null && Object.hasOwnProperty.call(message, "resourcePolicy")) + writer.uint32(/* id 159240835, wireType 2 =*/1273926682).string(message.resourcePolicy); + if (message.project != null && Object.hasOwnProperty.call(message, "project")) + writer.uint32(/* id 227560217, wireType 2 =*/1820481738).string(message.project); + if (message.updateMask != null && Object.hasOwnProperty.call(message, "updateMask")) + writer.uint32(/* id 500079778, wireType 2 =*/4000638226).string(message.updateMask); + return writer; + }; + + /** + * Encodes the specified PatchResourcePolicyRequest message, length delimited. Does not implicitly {@link google.cloud.compute.v1.PatchResourcePolicyRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @static + * @param {google.cloud.compute.v1.IPatchResourcePolicyRequest} message PatchResourcePolicyRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PatchResourcePolicyRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a PatchResourcePolicyRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.compute.v1.PatchResourcePolicyRequest} PatchResourcePolicyRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PatchResourcePolicyRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.compute.v1.PatchResourcePolicyRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 227560217: { + message.project = reader.string(); + break; + } + case 138946292: { + message.region = reader.string(); + break; + } + case 37109963: { + message.requestId = reader.string(); + break; + } + case 159240835: { + message.resourcePolicy = reader.string(); + break; + } + case 76826186: { + message.resourcePolicyResource = $root.google.cloud.compute.v1.ResourcePolicy.decode(reader, reader.uint32()); + break; + } + case 500079778: { + message.updateMask = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a PatchResourcePolicyRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.compute.v1.PatchResourcePolicyRequest} PatchResourcePolicyRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PatchResourcePolicyRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a PatchResourcePolicyRequest message. + * @function verify + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + PatchResourcePolicyRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + var properties = {}; + if (message.project != null && message.hasOwnProperty("project")) + if (!$util.isString(message.project)) + return "project: string expected"; + if (message.region != null && message.hasOwnProperty("region")) + if (!$util.isString(message.region)) + return "region: string expected"; + if (message.requestId != null && message.hasOwnProperty("requestId")) { + properties._requestId = 1; + if (!$util.isString(message.requestId)) + return "requestId: string expected"; + } + if (message.resourcePolicy != null && message.hasOwnProperty("resourcePolicy")) + if (!$util.isString(message.resourcePolicy)) + return "resourcePolicy: string expected"; + if (message.resourcePolicyResource != null && message.hasOwnProperty("resourcePolicyResource")) { + var error = $root.google.cloud.compute.v1.ResourcePolicy.verify(message.resourcePolicyResource); + if (error) + return "resourcePolicyResource." + error; + } + if (message.updateMask != null && message.hasOwnProperty("updateMask")) { + properties._updateMask = 1; + if (!$util.isString(message.updateMask)) + return "updateMask: string expected"; + } + return null; + }; + + /** + * Creates a PatchResourcePolicyRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.compute.v1.PatchResourcePolicyRequest} PatchResourcePolicyRequest + */ + PatchResourcePolicyRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.compute.v1.PatchResourcePolicyRequest) + return object; + var message = new $root.google.cloud.compute.v1.PatchResourcePolicyRequest(); + if (object.project != null) + message.project = String(object.project); + if (object.region != null) + message.region = String(object.region); + if (object.requestId != null) + message.requestId = String(object.requestId); + if (object.resourcePolicy != null) + message.resourcePolicy = String(object.resourcePolicy); + if (object.resourcePolicyResource != null) { + if (typeof object.resourcePolicyResource !== "object") + throw TypeError(".google.cloud.compute.v1.PatchResourcePolicyRequest.resourcePolicyResource: object expected"); + message.resourcePolicyResource = $root.google.cloud.compute.v1.ResourcePolicy.fromObject(object.resourcePolicyResource); + } + if (object.updateMask != null) + message.updateMask = String(object.updateMask); + return message; + }; + + /** + * Creates a plain object from a PatchResourcePolicyRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @static + * @param {google.cloud.compute.v1.PatchResourcePolicyRequest} message PatchResourcePolicyRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + PatchResourcePolicyRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.resourcePolicyResource = null; + object.region = ""; + object.resourcePolicy = ""; + object.project = ""; + } + if (message.requestId != null && message.hasOwnProperty("requestId")) { + object.requestId = message.requestId; + if (options.oneofs) + object._requestId = "requestId"; + } + if (message.resourcePolicyResource != null && message.hasOwnProperty("resourcePolicyResource")) + object.resourcePolicyResource = $root.google.cloud.compute.v1.ResourcePolicy.toObject(message.resourcePolicyResource, options); + if (message.region != null && message.hasOwnProperty("region")) + object.region = message.region; + if (message.resourcePolicy != null && message.hasOwnProperty("resourcePolicy")) + object.resourcePolicy = message.resourcePolicy; + if (message.project != null && message.hasOwnProperty("project")) + object.project = message.project; + if (message.updateMask != null && message.hasOwnProperty("updateMask")) { + object.updateMask = message.updateMask; + if (options.oneofs) + object._updateMask = "updateMask"; + } + return object; + }; + + /** + * Converts this PatchResourcePolicyRequest to JSON. + * @function toJSON + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @instance + * @returns {Object.} JSON object + */ + PatchResourcePolicyRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for PatchResourcePolicyRequest + * @function getTypeUrl + * @memberof google.cloud.compute.v1.PatchResourcePolicyRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + PatchResourcePolicyRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.compute.v1.PatchResourcePolicyRequest"; + }; + + return PatchResourcePolicyRequest; + })(); + v1.PatchRouterRequest = (function() { /** @@ -332420,9 +332780,11 @@ * @memberof google.cloud.compute.v1 * @interface IQuotaExceededInfo * @property {Object.|null} [dimensions] QuotaExceededInfo dimensions + * @property {number|null} [futureLimit] QuotaExceededInfo futureLimit * @property {number|null} [limit] QuotaExceededInfo limit * @property {string|null} [limitName] QuotaExceededInfo limitName * @property {string|null} [metricName] QuotaExceededInfo metricName + * @property {string|null} [rolloutStatus] QuotaExceededInfo rolloutStatus */ /** @@ -332449,6 +332811,14 @@ */ QuotaExceededInfo.prototype.dimensions = $util.emptyObject; + /** + * QuotaExceededInfo futureLimit. + * @member {number|null|undefined} futureLimit + * @memberof google.cloud.compute.v1.QuotaExceededInfo + * @instance + */ + QuotaExceededInfo.prototype.futureLimit = null; + /** * QuotaExceededInfo limit. * @member {number|null|undefined} limit @@ -332473,9 +332843,28 @@ */ QuotaExceededInfo.prototype.metricName = null; + /** + * QuotaExceededInfo rolloutStatus. + * @member {string|null|undefined} rolloutStatus + * @memberof google.cloud.compute.v1.QuotaExceededInfo + * @instance + */ + QuotaExceededInfo.prototype.rolloutStatus = null; + // OneOf field names bound to virtual getters and setters var $oneOfFields; + /** + * QuotaExceededInfo _futureLimit. + * @member {"futureLimit"|undefined} _futureLimit + * @memberof google.cloud.compute.v1.QuotaExceededInfo + * @instance + */ + Object.defineProperty(QuotaExceededInfo.prototype, "_futureLimit", { + get: $util.oneOfGetter($oneOfFields = ["futureLimit"]), + set: $util.oneOfSetter($oneOfFields) + }); + /** * QuotaExceededInfo _limit. * @member {"limit"|undefined} _limit @@ -332509,6 +332898,17 @@ set: $util.oneOfSetter($oneOfFields) }); + /** + * QuotaExceededInfo _rolloutStatus. + * @member {"rolloutStatus"|undefined} _rolloutStatus + * @memberof google.cloud.compute.v1.QuotaExceededInfo + * @instance + */ + Object.defineProperty(QuotaExceededInfo.prototype, "_rolloutStatus", { + get: $util.oneOfGetter($oneOfFields = ["rolloutStatus"]), + set: $util.oneOfSetter($oneOfFields) + }); + /** * Creates a new QuotaExceededInfo instance using the specified properties. * @function create @@ -332542,6 +332942,10 @@ if (message.dimensions != null && Object.hasOwnProperty.call(message, "dimensions")) for (var keys = Object.keys(message.dimensions), i = 0; i < keys.length; ++i) writer.uint32(/* id 414334925, wireType 2 =*/3314679402).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.dimensions[keys[i]]).ldelim(); + if (message.futureLimit != null && Object.hasOwnProperty.call(message, "futureLimit")) + writer.uint32(/* id 456564287, wireType 1 =*/3652514297).double(message.futureLimit); + if (message.rolloutStatus != null && Object.hasOwnProperty.call(message, "rolloutStatus")) + writer.uint32(/* id 476426816, wireType 2 =*/3811414530).string(message.rolloutStatus); return writer; }; @@ -332599,6 +333003,10 @@ message.dimensions[key] = value; break; } + case 456564287: { + message.futureLimit = reader.double(); + break; + } case 102976443: { message.limit = reader.double(); break; @@ -332611,6 +333019,10 @@ message.metricName = reader.string(); break; } + case 476426816: { + message.rolloutStatus = reader.string(); + break; + } default: reader.skipType(tag & 7); break; @@ -332655,6 +333067,11 @@ if (!$util.isString(message.dimensions[key[i]])) return "dimensions: string{k:string} expected"; } + if (message.futureLimit != null && message.hasOwnProperty("futureLimit")) { + properties._futureLimit = 1; + if (typeof message.futureLimit !== "number") + return "futureLimit: number expected"; + } if (message.limit != null && message.hasOwnProperty("limit")) { properties._limit = 1; if (typeof message.limit !== "number") @@ -332670,6 +333087,11 @@ if (!$util.isString(message.metricName)) return "metricName: string expected"; } + if (message.rolloutStatus != null && message.hasOwnProperty("rolloutStatus")) { + properties._rolloutStatus = 1; + if (!$util.isString(message.rolloutStatus)) + return "rolloutStatus: string expected"; + } return null; }; @@ -332692,12 +333114,16 @@ for (var keys = Object.keys(object.dimensions), i = 0; i < keys.length; ++i) message.dimensions[keys[i]] = String(object.dimensions[keys[i]]); } + if (object.futureLimit != null) + message.futureLimit = Number(object.futureLimit); if (object.limit != null) message.limit = Number(object.limit); if (object.limitName != null) message.limitName = String(object.limitName); if (object.metricName != null) message.metricName = String(object.metricName); + if (object.rolloutStatus != null) + message.rolloutStatus = String(object.rolloutStatus); return message; }; @@ -332737,6 +333163,16 @@ for (var j = 0; j < keys2.length; ++j) object.dimensions[keys2[j]] = message.dimensions[keys2[j]]; } + if (message.futureLimit != null && message.hasOwnProperty("futureLimit")) { + object.futureLimit = options.json && !isFinite(message.futureLimit) ? String(message.futureLimit) : message.futureLimit; + if (options.oneofs) + object._futureLimit = "futureLimit"; + } + if (message.rolloutStatus != null && message.hasOwnProperty("rolloutStatus")) { + object.rolloutStatus = message.rolloutStatus; + if (options.oneofs) + object._rolloutStatus = "rolloutStatus"; + } return object; }; @@ -332766,6 +333202,22 @@ return typeUrlPrefix + "/google.cloud.compute.v1.QuotaExceededInfo"; }; + /** + * RolloutStatus enum. + * @name google.cloud.compute.v1.QuotaExceededInfo.RolloutStatus + * @enum {number} + * @property {number} UNDEFINED_ROLLOUT_STATUS=0 UNDEFINED_ROLLOUT_STATUS value + * @property {number} IN_PROGRESS=469193735 IN_PROGRESS value + * @property {number} ROLLOUT_STATUS_UNSPECIFIED=26864568 ROLLOUT_STATUS_UNSPECIFIED value + */ + QuotaExceededInfo.RolloutStatus = (function() { + var valuesById = {}, values = Object.create(valuesById); + values[valuesById[0] = "UNDEFINED_ROLLOUT_STATUS"] = 0; + values[valuesById[469193735] = "IN_PROGRESS"] = 469193735; + values[valuesById[26864568] = "ROLLOUT_STATUS_UNSPECIFIED"] = 26864568; + return values; + })(); + return QuotaExceededInfo; })(); @@ -374077,6 +374529,7 @@ * @interface IScheduling * @property {boolean|null} [automaticRestart] Scheduling automaticRestart * @property {string|null} [instanceTerminationAction] Scheduling instanceTerminationAction + * @property {google.cloud.compute.v1.IDuration|null} [localSsdRecoveryTimeout] Scheduling localSsdRecoveryTimeout * @property {string|null} [locationHint] Scheduling locationHint * @property {number|null} [minNodeCpus] Scheduling minNodeCpus * @property {Array.|null} [nodeAffinities] Scheduling nodeAffinities @@ -374117,6 +374570,14 @@ */ Scheduling.prototype.instanceTerminationAction = null; + /** + * Scheduling localSsdRecoveryTimeout. + * @member {google.cloud.compute.v1.IDuration|null|undefined} localSsdRecoveryTimeout + * @memberof google.cloud.compute.v1.Scheduling + * @instance + */ + Scheduling.prototype.localSsdRecoveryTimeout = null; + /** * Scheduling locationHint. * @member {string|null|undefined} locationHint @@ -374190,6 +374651,17 @@ set: $util.oneOfSetter($oneOfFields) }); + /** + * Scheduling _localSsdRecoveryTimeout. + * @member {"localSsdRecoveryTimeout"|undefined} _localSsdRecoveryTimeout + * @memberof google.cloud.compute.v1.Scheduling + * @instance + */ + Object.defineProperty(Scheduling.prototype, "_localSsdRecoveryTimeout", { + get: $util.oneOfGetter($oneOfFields = ["localSsdRecoveryTimeout"]), + set: $util.oneOfSetter($oneOfFields) + }); + /** * Scheduling _locationHint. * @member {"locationHint"|undefined} _locationHint @@ -374275,6 +374747,8 @@ writer.uint32(/* id 64616796, wireType 2 =*/516934370).string(message.onHostMaintenance); if (message.instanceTerminationAction != null && Object.hasOwnProperty.call(message, "instanceTerminationAction")) writer.uint32(/* id 107380667, wireType 2 =*/859045338).string(message.instanceTerminationAction); + if (message.localSsdRecoveryTimeout != null && Object.hasOwnProperty.call(message, "localSsdRecoveryTimeout")) + $root.google.cloud.compute.v1.Duration.encode(message.localSsdRecoveryTimeout, writer.uint32(/* id 268015590, wireType 2 =*/2144124722).fork()).ldelim(); if (message.minNodeCpus != null && Object.hasOwnProperty.call(message, "minNodeCpus")) writer.uint32(/* id 317231675, wireType 0 =*/2537853400).int32(message.minNodeCpus); if (message.preemptible != null && Object.hasOwnProperty.call(message, "preemptible")) @@ -374328,6 +374802,10 @@ message.instanceTerminationAction = reader.string(); break; } + case 268015590: { + message.localSsdRecoveryTimeout = $root.google.cloud.compute.v1.Duration.decode(reader, reader.uint32()); + break; + } case 350519505: { message.locationHint = reader.string(); break; @@ -374400,6 +374878,14 @@ if (!$util.isString(message.instanceTerminationAction)) return "instanceTerminationAction: string expected"; } + if (message.localSsdRecoveryTimeout != null && message.hasOwnProperty("localSsdRecoveryTimeout")) { + properties._localSsdRecoveryTimeout = 1; + { + var error = $root.google.cloud.compute.v1.Duration.verify(message.localSsdRecoveryTimeout); + if (error) + return "localSsdRecoveryTimeout." + error; + } + } if (message.locationHint != null && message.hasOwnProperty("locationHint")) { properties._locationHint = 1; if (!$util.isString(message.locationHint)) @@ -374453,6 +374939,11 @@ message.automaticRestart = Boolean(object.automaticRestart); if (object.instanceTerminationAction != null) message.instanceTerminationAction = String(object.instanceTerminationAction); + if (object.localSsdRecoveryTimeout != null) { + if (typeof object.localSsdRecoveryTimeout !== "object") + throw TypeError(".google.cloud.compute.v1.Scheduling.localSsdRecoveryTimeout: object expected"); + message.localSsdRecoveryTimeout = $root.google.cloud.compute.v1.Duration.fromObject(object.localSsdRecoveryTimeout); + } if (object.locationHint != null) message.locationHint = String(object.locationHint); if (object.minNodeCpus != null) @@ -374506,6 +374997,11 @@ if (options.oneofs) object._instanceTerminationAction = "instanceTerminationAction"; } + if (message.localSsdRecoveryTimeout != null && message.hasOwnProperty("localSsdRecoveryTimeout")) { + object.localSsdRecoveryTimeout = $root.google.cloud.compute.v1.Duration.toObject(message.localSsdRecoveryTimeout, options); + if (options.oneofs) + object._localSsdRecoveryTimeout = "localSsdRecoveryTimeout"; + } if (message.minNodeCpus != null && message.hasOwnProperty("minNodeCpus")) { object.minNodeCpus = message.minNodeCpus; if (options.oneofs) @@ -386637,6 +387133,7 @@ * Properties of a ServiceAttachmentConnectedEndpoint. * @memberof google.cloud.compute.v1 * @interface IServiceAttachmentConnectedEndpoint + * @property {string|null} [consumerNetwork] ServiceAttachmentConnectedEndpoint consumerNetwork * @property {string|null} [endpoint] ServiceAttachmentConnectedEndpoint endpoint * @property {number|Long|null} [pscConnectionId] ServiceAttachmentConnectedEndpoint pscConnectionId * @property {string|null} [status] ServiceAttachmentConnectedEndpoint status @@ -386657,6 +387154,14 @@ this[keys[i]] = properties[keys[i]]; } + /** + * ServiceAttachmentConnectedEndpoint consumerNetwork. + * @member {string|null|undefined} consumerNetwork + * @memberof google.cloud.compute.v1.ServiceAttachmentConnectedEndpoint + * @instance + */ + ServiceAttachmentConnectedEndpoint.prototype.consumerNetwork = null; + /** * ServiceAttachmentConnectedEndpoint endpoint. * @member {string|null|undefined} endpoint @@ -386684,6 +387189,17 @@ // OneOf field names bound to virtual getters and setters var $oneOfFields; + /** + * ServiceAttachmentConnectedEndpoint _consumerNetwork. + * @member {"consumerNetwork"|undefined} _consumerNetwork + * @memberof google.cloud.compute.v1.ServiceAttachmentConnectedEndpoint + * @instance + */ + Object.defineProperty(ServiceAttachmentConnectedEndpoint.prototype, "_consumerNetwork", { + get: $util.oneOfGetter($oneOfFields = ["consumerNetwork"]), + set: $util.oneOfSetter($oneOfFields) + }); + /** * ServiceAttachmentConnectedEndpoint _endpoint. * @member {"endpoint"|undefined} _endpoint @@ -386745,6 +387261,8 @@ writer.uint32(/* id 130489749, wireType 2 =*/1043917994).string(message.endpoint); if (message.status != null && Object.hasOwnProperty.call(message, "status")) writer.uint32(/* id 181260274, wireType 2 =*/1450082194).string(message.status); + if (message.consumerNetwork != null && Object.hasOwnProperty.call(message, "consumerNetwork")) + writer.uint32(/* id 254357221, wireType 2 =*/2034857770).string(message.consumerNetwork); if (message.pscConnectionId != null && Object.hasOwnProperty.call(message, "pscConnectionId")) writer.uint32(/* id 292082397, wireType 0 =*/2336659176).uint64(message.pscConnectionId); return writer; @@ -386781,6 +387299,10 @@ while (reader.pos < end) { var tag = reader.uint32(); switch (tag >>> 3) { + case 254357221: { + message.consumerNetwork = reader.string(); + break; + } case 130489749: { message.endpoint = reader.string(); break; @@ -386829,6 +387351,11 @@ if (typeof message !== "object" || message === null) return "object expected"; var properties = {}; + if (message.consumerNetwork != null && message.hasOwnProperty("consumerNetwork")) { + properties._consumerNetwork = 1; + if (!$util.isString(message.consumerNetwork)) + return "consumerNetwork: string expected"; + } if (message.endpoint != null && message.hasOwnProperty("endpoint")) { properties._endpoint = 1; if (!$util.isString(message.endpoint)) @@ -386859,6 +387386,8 @@ if (object instanceof $root.google.cloud.compute.v1.ServiceAttachmentConnectedEndpoint) return object; var message = new $root.google.cloud.compute.v1.ServiceAttachmentConnectedEndpoint(); + if (object.consumerNetwork != null) + message.consumerNetwork = String(object.consumerNetwork); if (object.endpoint != null) message.endpoint = String(object.endpoint); if (object.pscConnectionId != null) @@ -386898,6 +387427,11 @@ if (options.oneofs) object._status = "status"; } + if (message.consumerNetwork != null && message.hasOwnProperty("consumerNetwork")) { + object.consumerNetwork = message.consumerNetwork; + if (options.oneofs) + object._consumerNetwork = "consumerNetwork"; + } if (message.pscConnectionId != null && message.hasOwnProperty("pscConnectionId")) { if (typeof message.pscConnectionId === "number") object.pscConnectionId = options.longs === String ? String(message.pscConnectionId) : message.pscConnectionId; @@ -500945,6 +501479,39 @@ * @variation 2 */ + /** + * Callback as used by {@link google.cloud.compute.v1.ResourcePolicies|patch}. + * @memberof google.cloud.compute.v1.ResourcePolicies + * @typedef PatchCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.compute.v1.Operation} [response] Operation + */ + + /** + * Calls Patch. + * @function patch + * @memberof google.cloud.compute.v1.ResourcePolicies + * @instance + * @param {google.cloud.compute.v1.IPatchResourcePolicyRequest} request PatchResourcePolicyRequest message or plain object + * @param {google.cloud.compute.v1.ResourcePolicies.PatchCallback} callback Node-style callback called with the error, if any, and Operation + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(ResourcePolicies.prototype.patch = function patch(request, callback) { + return this.rpcCall(patch, $root.google.cloud.compute.v1.PatchResourcePolicyRequest, $root.google.cloud.compute.v1.Operation, request, callback); + }, "name", { value: "Patch" }); + + /** + * Calls Patch. + * @function patch + * @memberof google.cloud.compute.v1.ResourcePolicies + * @instance + * @param {google.cloud.compute.v1.IPatchResourcePolicyRequest} request PatchResourcePolicyRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + /** * Callback as used by {@link google.cloud.compute.v1.ResourcePolicies|setIamPolicy}. * @memberof google.cloud.compute.v1.ResourcePolicies diff --git a/packages/google-cloud-compute/protos/protos.json b/packages/google-cloud-compute/protos/protos.json index e89684a2d950..977dbf5c9950 100644 --- a/packages/google-cloud-compute/protos/protos.json +++ b/packages/google-cloud-compute/protos/protos.json @@ -15908,6 +15908,7 @@ "values": { "UNDEFINED_TARGET_SHAPE": 0, "ANY": 64972, + "ANY_SINGLE_ZONE": 61100880, "BALANCED": 468409608, "EVEN": 2140442 } @@ -50308,6 +50309,66 @@ } } }, + "PatchResourcePolicyRequest": { + "oneofs": { + "_requestId": { + "oneof": [ + "requestId" + ] + }, + "_updateMask": { + "oneof": [ + "updateMask" + ] + } + }, + "fields": { + "project": { + "type": "string", + "id": 227560217, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.cloud.operation_request_field)": "project" + } + }, + "region": { + "type": "string", + "id": 138946292, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.cloud.operation_request_field)": "region" + } + }, + "requestId": { + "type": "string", + "id": 37109963, + "options": { + "proto3_optional": true + } + }, + "resourcePolicy": { + "type": "string", + "id": 159240835, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "resourcePolicyResource": { + "type": "ResourcePolicy", + "id": 76826186, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "updateMask": { + "type": "string", + "id": 500079778, + "options": { + "proto3_optional": true + } + } + } + }, "PatchRouterRequest": { "oneofs": { "_requestId": { @@ -52530,6 +52591,11 @@ }, "QuotaExceededInfo": { "oneofs": { + "_futureLimit": { + "oneof": [ + "futureLimit" + ] + }, "_limit": { "oneof": [ "limit" @@ -52544,6 +52610,11 @@ "oneof": [ "metricName" ] + }, + "_rolloutStatus": { + "oneof": [ + "rolloutStatus" + ] } }, "fields": { @@ -52552,6 +52623,13 @@ "type": "string", "id": 414334925 }, + "futureLimit": { + "type": "double", + "id": 456564287, + "options": { + "proto3_optional": true + } + }, "limit": { "type": "double", "id": 102976443, @@ -52572,6 +52650,22 @@ "options": { "proto3_optional": true } + }, + "rolloutStatus": { + "type": "string", + "id": 476426816, + "options": { + "proto3_optional": true + } + } + }, + "nested": { + "RolloutStatus": { + "values": { + "UNDEFINED_ROLLOUT_STATUS": 0, + "IN_PROGRESS": 469193735, + "ROLLOUT_STATUS_UNSPECIFIED": 26864568 + } } } }, @@ -58834,6 +58928,11 @@ "instanceTerminationAction" ] }, + "_localSsdRecoveryTimeout": { + "oneof": [ + "localSsdRecoveryTimeout" + ] + }, "_locationHint": { "oneof": [ "locationHint" @@ -58875,6 +58974,13 @@ "proto3_optional": true } }, + "localSsdRecoveryTimeout": { + "type": "Duration", + "id": 268015590, + "options": { + "proto3_optional": true + } + }, "locationHint": { "type": "string", "id": 350519505, @@ -60630,6 +60736,11 @@ }, "ServiceAttachmentConnectedEndpoint": { "oneofs": { + "_consumerNetwork": { + "oneof": [ + "consumerNetwork" + ] + }, "_endpoint": { "oneof": [ "endpoint" @@ -60647,6 +60758,13 @@ } }, "fields": { + "consumerNetwork": { + "type": "string", + "id": 254357221, + "options": { + "proto3_optional": true + } + }, "endpoint": { "type": "string", "id": 130489749, @@ -86381,6 +86499,30 @@ } ] }, + "Patch": { + "requestType": "PatchResourcePolicyRequest", + "responseType": "Operation", + "options": { + "(google.api.http).body": "resource_policy_resource", + "(google.api.http).patch": "/compute/v1/projects/{project}/regions/{region}/resourcePolicies/{resource_policy}", + "(google.api.method_signature)": "project,region,resource_policy,resource_policy_resource", + "(google.cloud.operation_service)": "RegionOperations" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "body": "resource_policy_resource", + "patch": "/compute/v1/projects/{project}/regions/{region}/resourcePolicies/{resource_policy}" + } + }, + { + "(google.api.method_signature)": "project,region,resource_policy,resource_policy_resource" + }, + { + "(google.cloud.operation_service)": "RegionOperations" + } + ] + }, "SetIamPolicy": { "requestType": "SetIamPolicyResourcePolicyRequest", "responseType": "Policy", diff --git a/packages/google-cloud-compute/samples/README.md b/packages/google-cloud-compute/samples/README.md index fc1d53d8bc27..7d1258c3d84b 100644 --- a/packages/google-cloud-compute/samples/README.md +++ b/packages/google-cloud-compute/samples/README.md @@ -551,6 +551,7 @@ * [Resource_policies.get_iam_policy](#resource_policies.get_iam_policy) * [Resource_policies.insert](#resource_policies.insert) * [Resource_policies.list](#resource_policies.list) + * [Resource_policies.patch](#resource_policies.patch) * [Resource_policies.set_iam_policy](#resource_policies.set_iam_policy) * [Resource_policies.test_iam_permissions](#resource_policies.test_iam_permissions) * [Routers.aggregated_list](#routers.aggregated_list) @@ -9896,6 +9897,23 @@ __Usage:__ +### Resource_policies.patch + +View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-compute/samples/generated/v1/resource_policies.patch.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-compute/samples/generated/v1/resource_policies.patch.js,samples/README.md) + +__Usage:__ + + +`node packages/google-cloud-compute/samples/generated/v1/resource_policies.patch.js` + + +----- + + + + ### Resource_policies.set_iam_policy View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-compute/samples/generated/v1/resource_policies.set_iam_policy.js). diff --git a/packages/google-cloud-compute/samples/generated/v1/resource_policies.patch.js b/packages/google-cloud-compute/samples/generated/v1/resource_policies.patch.js new file mode 100644 index 000000000000..4e9c8c6be495 --- /dev/null +++ b/packages/google-cloud-compute/samples/generated/v1/resource_policies.patch.js @@ -0,0 +1,84 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(project, region, resourcePolicy, resourcePolicyResource) { + // [START compute_v1_generated_ResourcePolicies_Patch_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Project ID for this request. + */ + // const project = 'my-project' + /** + * Name of the region for this request. + */ + // const region = 'us-central1' + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + // const requestId = 'abc123' + /** + * Id of the resource policy to patch. + */ + // const resourcePolicy = 'abc123' + /** + * The body resource for this request + */ + // const resourcePolicyResource = {} + /** + * update_mask indicates fields to be updated as part of this request. + */ + // const updateMask = 'abc123' + + // Imports the Compute library + const {ResourcePoliciesClient} = require('@google-cloud/compute').v1; + + // Instantiates a client + const computeClient = new ResourcePoliciesClient(); + + async function callPatch() { + // Construct request + const request = { + project, + region, + resourcePolicy, + resourcePolicyResource, + }; + + // Run request + const response = await computeClient.patch(request); + console.log(response); + } + + callPatch(); + // [END compute_v1_generated_ResourcePolicies_Patch_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-compute/samples/generated/v1/snippet_metadata_google.cloud.compute.v1.json b/packages/google-cloud-compute/samples/generated/v1/snippet_metadata_google.cloud.compute.v1.json new file mode 100644 index 000000000000..de939fa7a646 --- /dev/null +++ b/packages/google-cloud-compute/samples/generated/v1/snippet_metadata_google.cloud.compute.v1.json @@ -0,0 +1,37591 @@ +{ + "clientLibrary": { + "name": "nodejs-compute", + "version": "3.10.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.compute.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "compute_v1_generated_AcceleratorTypes_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of accelerator types.", + "canonical": true, + "file": "accelerator_types.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.AcceleratorTypes.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.AcceleratorTypeAggregatedList", + "client": { + "shortName": "AcceleratorTypesClient", + "fullName": "google.cloud.compute.v1.AcceleratorTypesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.AcceleratorTypes.AggregatedList", + "service": { + "shortName": "AcceleratorTypes", + "fullName": "google.cloud.compute.v1.AcceleratorTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_AcceleratorTypes_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified accelerator type.", + "canonical": true, + "file": "accelerator_types.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.AcceleratorTypes.Get", + "async": true, + "parameters": [ + { + "name": "accelerator_type", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.AcceleratorType", + "client": { + "shortName": "AcceleratorTypesClient", + "fullName": "google.cloud.compute.v1.AcceleratorTypesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.AcceleratorTypes.Get", + "service": { + "shortName": "AcceleratorTypes", + "fullName": "google.cloud.compute.v1.AcceleratorTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_AcceleratorTypes_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of accelerator types that are available to the specified project.", + "canonical": true, + "file": "accelerator_types.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.AcceleratorTypes.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.AcceleratorTypeList", + "client": { + "shortName": "AcceleratorTypesClient", + "fullName": "google.cloud.compute.v1.AcceleratorTypesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.AcceleratorTypes.List", + "service": { + "shortName": "AcceleratorTypes", + "fullName": "google.cloud.compute.v1.AcceleratorTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Addresses_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of addresses.", + "canonical": true, + "file": "addresses.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Addresses.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.AddressAggregatedList", + "client": { + "shortName": "AddressesClient", + "fullName": "google.cloud.compute.v1.AddressesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Addresses.AggregatedList", + "service": { + "shortName": "Addresses", + "fullName": "google.cloud.compute.v1.Addresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Addresses_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified address resource.", + "canonical": true, + "file": "addresses.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Addresses.Delete", + "async": true, + "parameters": [ + { + "name": "address", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "AddressesClient", + "fullName": "google.cloud.compute.v1.AddressesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Addresses.Delete", + "service": { + "shortName": "Addresses", + "fullName": "google.cloud.compute.v1.Addresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Addresses_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified address resource.", + "canonical": true, + "file": "addresses.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Addresses.Get", + "async": true, + "parameters": [ + { + "name": "address", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Address", + "client": { + "shortName": "AddressesClient", + "fullName": "google.cloud.compute.v1.AddressesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Addresses.Get", + "service": { + "shortName": "Addresses", + "fullName": "google.cloud.compute.v1.Addresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Addresses_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an address resource in the specified project by using the data included in the request.", + "canonical": true, + "file": "addresses.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Addresses.Insert", + "async": true, + "parameters": [ + { + "name": "address_resource", + "type": ".google.cloud.compute.v1.Address" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "AddressesClient", + "fullName": "google.cloud.compute.v1.AddressesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Addresses.Insert", + "service": { + "shortName": "Addresses", + "fullName": "google.cloud.compute.v1.Addresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Addresses_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of addresses contained within the specified region.", + "canonical": true, + "file": "addresses.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Addresses.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.AddressList", + "client": { + "shortName": "AddressesClient", + "fullName": "google.cloud.compute.v1.AddressesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Addresses.List", + "service": { + "shortName": "Addresses", + "fullName": "google.cloud.compute.v1.Addresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Addresses_Move_async", + "title": "AcceleratorTypes move Sample", + "origin": "API_DEFINITION", + "description": " Moves the specified address resource.", + "canonical": true, + "file": "addresses.move.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Move", + "fullName": "google.cloud.compute.v1.Addresses.Move", + "async": true, + "parameters": [ + { + "name": "address", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_addresses_move_request_resource", + "type": ".google.cloud.compute.v1.RegionAddressesMoveRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "AddressesClient", + "fullName": "google.cloud.compute.v1.AddressesClient" + }, + "method": { + "shortName": "Move", + "fullName": "google.cloud.compute.v1.Addresses.Move", + "service": { + "shortName": "Addresses", + "fullName": "google.cloud.compute.v1.Addresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Addresses_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "addresses.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Addresses.SetLabels", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_labels_request_resource", + "type": ".google.cloud.compute.v1.RegionSetLabelsRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "AddressesClient", + "fullName": "google.cloud.compute.v1.AddressesClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Addresses.SetLabels", + "service": { + "shortName": "Addresses", + "fullName": "google.cloud.compute.v1.Addresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Autoscalers_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of autoscalers.", + "canonical": true, + "file": "autoscalers.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Autoscalers.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.AutoscalerAggregatedList", + "client": { + "shortName": "AutoscalersClient", + "fullName": "google.cloud.compute.v1.AutoscalersClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Autoscalers.AggregatedList", + "service": { + "shortName": "Autoscalers", + "fullName": "google.cloud.compute.v1.Autoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Autoscalers_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified autoscaler.", + "canonical": true, + "file": "autoscalers.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Autoscalers.Delete", + "async": true, + "parameters": [ + { + "name": "autoscaler", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "AutoscalersClient", + "fullName": "google.cloud.compute.v1.AutoscalersClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Autoscalers.Delete", + "service": { + "shortName": "Autoscalers", + "fullName": "google.cloud.compute.v1.Autoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Autoscalers_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified autoscaler resource.", + "canonical": true, + "file": "autoscalers.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Autoscalers.Get", + "async": true, + "parameters": [ + { + "name": "autoscaler", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Autoscaler", + "client": { + "shortName": "AutoscalersClient", + "fullName": "google.cloud.compute.v1.AutoscalersClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Autoscalers.Get", + "service": { + "shortName": "Autoscalers", + "fullName": "google.cloud.compute.v1.Autoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Autoscalers_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an autoscaler in the specified project using the data included in the request.", + "canonical": true, + "file": "autoscalers.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Autoscalers.Insert", + "async": true, + "parameters": [ + { + "name": "autoscaler_resource", + "type": ".google.cloud.compute.v1.Autoscaler" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "AutoscalersClient", + "fullName": "google.cloud.compute.v1.AutoscalersClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Autoscalers.Insert", + "service": { + "shortName": "Autoscalers", + "fullName": "google.cloud.compute.v1.Autoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Autoscalers_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of autoscalers contained within the specified zone.", + "canonical": true, + "file": "autoscalers.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Autoscalers.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.AutoscalerList", + "client": { + "shortName": "AutoscalersClient", + "fullName": "google.cloud.compute.v1.AutoscalersClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Autoscalers.List", + "service": { + "shortName": "Autoscalers", + "fullName": "google.cloud.compute.v1.Autoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Autoscalers_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "autoscalers.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Autoscalers.Patch", + "async": true, + "parameters": [ + { + "name": "autoscaler", + "type": "TYPE_STRING" + }, + { + "name": "autoscaler_resource", + "type": ".google.cloud.compute.v1.Autoscaler" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "AutoscalersClient", + "fullName": "google.cloud.compute.v1.AutoscalersClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Autoscalers.Patch", + "service": { + "shortName": "Autoscalers", + "fullName": "google.cloud.compute.v1.Autoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Autoscalers_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates an autoscaler in the specified project using the data included in the request.", + "canonical": true, + "file": "autoscalers.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Autoscalers.Update", + "async": true, + "parameters": [ + { + "name": "autoscaler", + "type": "TYPE_STRING" + }, + { + "name": "autoscaler_resource", + "type": ".google.cloud.compute.v1.Autoscaler" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "AutoscalersClient", + "fullName": "google.cloud.compute.v1.AutoscalersClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Autoscalers.Update", + "service": { + "shortName": "Autoscalers", + "fullName": "google.cloud.compute.v1.Autoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendBuckets_AddSignedUrlKey_async", + "title": "AcceleratorTypes addSignedUrlKey Sample", + "origin": "API_DEFINITION", + "description": " Adds a key for validating requests with signed URLs for this backend bucket.", + "canonical": true, + "file": "backend_buckets.add_signed_url_key.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddSignedUrlKey", + "fullName": "google.cloud.compute.v1.BackendBuckets.AddSignedUrlKey", + "async": true, + "parameters": [ + { + "name": "backend_bucket", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "signed_url_key_resource", + "type": ".google.cloud.compute.v1.SignedUrlKey" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendBucketsClient", + "fullName": "google.cloud.compute.v1.BackendBucketsClient" + }, + "method": { + "shortName": "AddSignedUrlKey", + "fullName": "google.cloud.compute.v1.BackendBuckets.AddSignedUrlKey", + "service": { + "shortName": "BackendBuckets", + "fullName": "google.cloud.compute.v1.BackendBuckets" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendBuckets_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified BackendBucket resource.", + "canonical": true, + "file": "backend_buckets.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.BackendBuckets.Delete", + "async": true, + "parameters": [ + { + "name": "backend_bucket", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendBucketsClient", + "fullName": "google.cloud.compute.v1.BackendBucketsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.BackendBuckets.Delete", + "service": { + "shortName": "BackendBuckets", + "fullName": "google.cloud.compute.v1.BackendBuckets" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendBuckets_DeleteSignedUrlKey_async", + "title": "AcceleratorTypes deleteSignedUrlKey Sample", + "origin": "API_DEFINITION", + "description": " Deletes a key for validating requests with signed URLs for this backend bucket.", + "canonical": true, + "file": "backend_buckets.delete_signed_url_key.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSignedUrlKey", + "fullName": "google.cloud.compute.v1.BackendBuckets.DeleteSignedUrlKey", + "async": true, + "parameters": [ + { + "name": "backend_bucket", + "type": "TYPE_STRING" + }, + { + "name": "key_name", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendBucketsClient", + "fullName": "google.cloud.compute.v1.BackendBucketsClient" + }, + "method": { + "shortName": "DeleteSignedUrlKey", + "fullName": "google.cloud.compute.v1.BackendBuckets.DeleteSignedUrlKey", + "service": { + "shortName": "BackendBuckets", + "fullName": "google.cloud.compute.v1.BackendBuckets" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendBuckets_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified BackendBucket resource.", + "canonical": true, + "file": "backend_buckets.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.BackendBuckets.Get", + "async": true, + "parameters": [ + { + "name": "backend_bucket", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.BackendBucket", + "client": { + "shortName": "BackendBucketsClient", + "fullName": "google.cloud.compute.v1.BackendBucketsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.BackendBuckets.Get", + "service": { + "shortName": "BackendBuckets", + "fullName": "google.cloud.compute.v1.BackendBuckets" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendBuckets_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a BackendBucket resource in the specified project using the data included in the request.", + "canonical": true, + "file": "backend_buckets.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.BackendBuckets.Insert", + "async": true, + "parameters": [ + { + "name": "backend_bucket_resource", + "type": ".google.cloud.compute.v1.BackendBucket" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendBucketsClient", + "fullName": "google.cloud.compute.v1.BackendBucketsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.BackendBuckets.Insert", + "service": { + "shortName": "BackendBuckets", + "fullName": "google.cloud.compute.v1.BackendBuckets" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendBuckets_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of BackendBucket resources available to the specified project.", + "canonical": true, + "file": "backend_buckets.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.BackendBuckets.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.BackendBucketList", + "client": { + "shortName": "BackendBucketsClient", + "fullName": "google.cloud.compute.v1.BackendBucketsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.BackendBuckets.List", + "service": { + "shortName": "BackendBuckets", + "fullName": "google.cloud.compute.v1.BackendBuckets" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendBuckets_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "backend_buckets.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.BackendBuckets.Patch", + "async": true, + "parameters": [ + { + "name": "backend_bucket", + "type": "TYPE_STRING" + }, + { + "name": "backend_bucket_resource", + "type": ".google.cloud.compute.v1.BackendBucket" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendBucketsClient", + "fullName": "google.cloud.compute.v1.BackendBucketsClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.BackendBuckets.Patch", + "service": { + "shortName": "BackendBuckets", + "fullName": "google.cloud.compute.v1.BackendBuckets" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendBuckets_SetEdgeSecurityPolicy_async", + "title": "AcceleratorTypes setEdgeSecurityPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the edge security policy for the specified backend bucket.", + "canonical": true, + "file": "backend_buckets.set_edge_security_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetEdgeSecurityPolicy", + "fullName": "google.cloud.compute.v1.BackendBuckets.SetEdgeSecurityPolicy", + "async": true, + "parameters": [ + { + "name": "backend_bucket", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "security_policy_reference_resource", + "type": ".google.cloud.compute.v1.SecurityPolicyReference" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendBucketsClient", + "fullName": "google.cloud.compute.v1.BackendBucketsClient" + }, + "method": { + "shortName": "SetEdgeSecurityPolicy", + "fullName": "google.cloud.compute.v1.BackendBuckets.SetEdgeSecurityPolicy", + "service": { + "shortName": "BackendBuckets", + "fullName": "google.cloud.compute.v1.BackendBuckets" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendBuckets_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified BackendBucket resource with the data included in the request.", + "canonical": true, + "file": "backend_buckets.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.BackendBuckets.Update", + "async": true, + "parameters": [ + { + "name": "backend_bucket", + "type": "TYPE_STRING" + }, + { + "name": "backend_bucket_resource", + "type": ".google.cloud.compute.v1.BackendBucket" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendBucketsClient", + "fullName": "google.cloud.compute.v1.BackendBucketsClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.BackendBuckets.Update", + "service": { + "shortName": "BackendBuckets", + "fullName": "google.cloud.compute.v1.BackendBuckets" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_AddSignedUrlKey_async", + "title": "AcceleratorTypes addSignedUrlKey Sample", + "origin": "API_DEFINITION", + "description": " Adds a key for validating requests with signed URLs for this backend service.", + "canonical": true, + "file": "backend_services.add_signed_url_key.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddSignedUrlKey", + "fullName": "google.cloud.compute.v1.BackendServices.AddSignedUrlKey", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "signed_url_key_resource", + "type": ".google.cloud.compute.v1.SignedUrlKey" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "AddSignedUrlKey", + "fullName": "google.cloud.compute.v1.BackendServices.AddSignedUrlKey", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all BackendService resources, regional and global, available to the specified project.", + "canonical": true, + "file": "backend_services.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.BackendServices.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.BackendServiceAggregatedList", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.BackendServices.AggregatedList", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified BackendService resource.", + "canonical": true, + "file": "backend_services.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.BackendServices.Delete", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.BackendServices.Delete", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_DeleteSignedUrlKey_async", + "title": "AcceleratorTypes deleteSignedUrlKey Sample", + "origin": "API_DEFINITION", + "description": " Deletes a key for validating requests with signed URLs for this backend service.", + "canonical": true, + "file": "backend_services.delete_signed_url_key.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSignedUrlKey", + "fullName": "google.cloud.compute.v1.BackendServices.DeleteSignedUrlKey", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "key_name", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "DeleteSignedUrlKey", + "fullName": "google.cloud.compute.v1.BackendServices.DeleteSignedUrlKey", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified BackendService resource.", + "canonical": true, + "file": "backend_services.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.BackendServices.Get", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.BackendService", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.BackendServices.Get", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_GetHealth_async", + "title": "AcceleratorTypes getHealth Sample", + "origin": "API_DEFINITION", + "description": " Gets the most recent health check results for this BackendService. Example request body: { \"group\": \"/zones/us-east1-b/instanceGroups/lb-backend-example\" }", + "canonical": true, + "file": "backend_services.get_health.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetHealth", + "fullName": "google.cloud.compute.v1.BackendServices.GetHealth", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource_group_reference_resource", + "type": ".google.cloud.compute.v1.ResourceGroupReference" + } + ], + "resultType": ".google.cloud.compute.v1.BackendServiceGroupHealth", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "GetHealth", + "fullName": "google.cloud.compute.v1.BackendServices.GetHealth", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "backend_services.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.BackendServices.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.BackendServices.GetIamPolicy", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview .", + "canonical": true, + "file": "backend_services.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.BackendServices.Insert", + "async": true, + "parameters": [ + { + "name": "backend_service_resource", + "type": ".google.cloud.compute.v1.BackendService" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.BackendServices.Insert", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of BackendService resources available to the specified project.", + "canonical": true, + "file": "backend_services.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.BackendServices.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.BackendServiceList", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.BackendServices.List", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "backend_services.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.BackendServices.Patch", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "backend_service_resource", + "type": ".google.cloud.compute.v1.BackendService" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.BackendServices.Patch", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_SetEdgeSecurityPolicy_async", + "title": "AcceleratorTypes setEdgeSecurityPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the edge security policy for the specified backend service.", + "canonical": true, + "file": "backend_services.set_edge_security_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetEdgeSecurityPolicy", + "fullName": "google.cloud.compute.v1.BackendServices.SetEdgeSecurityPolicy", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "security_policy_reference_resource", + "type": ".google.cloud.compute.v1.SecurityPolicyReference" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "SetEdgeSecurityPolicy", + "fullName": "google.cloud.compute.v1.BackendServices.SetEdgeSecurityPolicy", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "backend_services.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.BackendServices.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "global_set_policy_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetPolicyRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.BackendServices.SetIamPolicy", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_SetSecurityPolicy_async", + "title": "AcceleratorTypes setSecurityPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview", + "canonical": true, + "file": "backend_services.set_security_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetSecurityPolicy", + "fullName": "google.cloud.compute.v1.BackendServices.SetSecurityPolicy", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "security_policy_reference_resource", + "type": ".google.cloud.compute.v1.SecurityPolicyReference" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "SetSecurityPolicy", + "fullName": "google.cloud.compute.v1.BackendServices.SetSecurityPolicy", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_BackendServices_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.", + "canonical": true, + "file": "backend_services.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.BackendServices.Update", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "backend_service_resource", + "type": ".google.cloud.compute.v1.BackendService" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "BackendServicesClient", + "fullName": "google.cloud.compute.v1.BackendServicesClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.BackendServices.Update", + "service": { + "shortName": "BackendServices", + "fullName": "google.cloud.compute.v1.BackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_AddResourcePolicies_async", + "title": "AcceleratorTypes addResourcePolicies Sample", + "origin": "API_DEFINITION", + "description": " Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.", + "canonical": true, + "file": "disks.add_resource_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddResourcePolicies", + "fullName": "google.cloud.compute.v1.Disks.AddResourcePolicies", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "disks_add_resource_policies_request_resource", + "type": ".google.cloud.compute.v1.DisksAddResourcePoliciesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "AddResourcePolicies", + "fullName": "google.cloud.compute.v1.Disks.AddResourcePolicies", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of persistent disks.", + "canonical": true, + "file": "disks.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Disks.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.DiskAggregatedList", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Disks.AggregatedList", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_BulkInsert_async", + "title": "AcceleratorTypes bulkInsert Sample", + "origin": "API_DEFINITION", + "description": " Bulk create a set of disks.", + "canonical": true, + "file": "disks.bulk_insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BulkInsert", + "fullName": "google.cloud.compute.v1.Disks.BulkInsert", + "async": true, + "parameters": [ + { + "name": "bulk_insert_disk_resource_resource", + "type": ".google.cloud.compute.v1.BulkInsertDiskResource" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "BulkInsert", + "fullName": "google.cloud.compute.v1.Disks.BulkInsert", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_CreateSnapshot_async", + "title": "AcceleratorTypes createSnapshot Sample", + "origin": "API_DEFINITION", + "description": " Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.", + "canonical": true, + "file": "disks.create_snapshot.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSnapshot", + "fullName": "google.cloud.compute.v1.Disks.CreateSnapshot", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "guest_flush", + "type": "TYPE_BOOL" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "snapshot_resource", + "type": ".google.cloud.compute.v1.Snapshot" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "CreateSnapshot", + "fullName": "google.cloud.compute.v1.Disks.CreateSnapshot", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.", + "canonical": true, + "file": "disks.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Disks.Delete", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Disks.Delete", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified persistent disk.", + "canonical": true, + "file": "disks.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Disks.Get", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Disk", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Disks.Get", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "disks.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Disks.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Disks.GetIamPolicy", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.", + "canonical": true, + "file": "disks.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Disks.Insert", + "async": true, + "parameters": [ + { + "name": "disk_resource", + "type": ".google.cloud.compute.v1.Disk" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "source_image", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Disks.Insert", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of persistent disks contained within the specified zone.", + "canonical": true, + "file": "disks.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Disks.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.DiskList", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Disks.List", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_RemoveResourcePolicies_async", + "title": "AcceleratorTypes removeResourcePolicies Sample", + "origin": "API_DEFINITION", + "description": " Removes resource policies from a disk.", + "canonical": true, + "file": "disks.remove_resource_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveResourcePolicies", + "fullName": "google.cloud.compute.v1.Disks.RemoveResourcePolicies", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "disks_remove_resource_policies_request_resource", + "type": ".google.cloud.compute.v1.DisksRemoveResourcePoliciesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "RemoveResourcePolicies", + "fullName": "google.cloud.compute.v1.Disks.RemoveResourcePolicies", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_Resize_async", + "title": "AcceleratorTypes resize Sample", + "origin": "API_DEFINITION", + "description": " Resizes the specified persistent disk. You can only increase the size of the disk.", + "canonical": true, + "file": "disks.resize.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Resize", + "fullName": "google.cloud.compute.v1.Disks.Resize", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "disks_resize_request_resource", + "type": ".google.cloud.compute.v1.DisksResizeRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "Resize", + "fullName": "google.cloud.compute.v1.Disks.Resize", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "disks.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Disks.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + }, + { + "name": "zone_set_policy_request_resource", + "type": ".google.cloud.compute.v1.ZoneSetPolicyRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Disks.SetIamPolicy", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "disks.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Disks.SetLabels", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + }, + { + "name": "zone_set_labels_request_resource", + "type": ".google.cloud.compute.v1.ZoneSetLabelsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Disks.SetLabels", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_StartAsyncReplication_async", + "title": "AcceleratorTypes startAsyncReplication Sample", + "origin": "API_DEFINITION", + "description": " Starts asynchronous replication. Must be invoked on the primary disk.", + "canonical": true, + "file": "disks.start_async_replication.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StartAsyncReplication", + "fullName": "google.cloud.compute.v1.Disks.StartAsyncReplication", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "disks_start_async_replication_request_resource", + "type": ".google.cloud.compute.v1.DisksStartAsyncReplicationRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "StartAsyncReplication", + "fullName": "google.cloud.compute.v1.Disks.StartAsyncReplication", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_StopAsyncReplication_async", + "title": "AcceleratorTypes stopAsyncReplication Sample", + "origin": "API_DEFINITION", + "description": " Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.", + "canonical": true, + "file": "disks.stop_async_replication.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StopAsyncReplication", + "fullName": "google.cloud.compute.v1.Disks.StopAsyncReplication", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "StopAsyncReplication", + "fullName": "google.cloud.compute.v1.Disks.StopAsyncReplication", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_StopGroupAsyncReplication_async", + "title": "AcceleratorTypes stopGroupAsyncReplication Sample", + "origin": "API_DEFINITION", + "description": " Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.", + "canonical": true, + "file": "disks.stop_group_async_replication.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StopGroupAsyncReplication", + "fullName": "google.cloud.compute.v1.Disks.StopGroupAsyncReplication", + "async": true, + "parameters": [ + { + "name": "disks_stop_group_async_replication_resource_resource", + "type": ".google.cloud.compute.v1.DisksStopGroupAsyncReplicationResource" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "StopGroupAsyncReplication", + "fullName": "google.cloud.compute.v1.Disks.StopGroupAsyncReplication", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "disks.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Disks.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Disks.TestIamPermissions", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Disks_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.", + "canonical": true, + "file": "disks.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Disks.Update", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "disk_resource", + "type": ".google.cloud.compute.v1.Disk" + }, + { + "name": "paths", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "update_mask", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "DisksClient", + "fullName": "google.cloud.compute.v1.DisksClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Disks.Update", + "service": { + "shortName": "Disks", + "fullName": "google.cloud.compute.v1.Disks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_DiskTypes_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of disk types.", + "canonical": true, + "file": "disk_types.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.DiskTypes.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.DiskTypeAggregatedList", + "client": { + "shortName": "DiskTypesClient", + "fullName": "google.cloud.compute.v1.DiskTypesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.DiskTypes.AggregatedList", + "service": { + "shortName": "DiskTypes", + "fullName": "google.cloud.compute.v1.DiskTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_DiskTypes_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified disk type.", + "canonical": true, + "file": "disk_types.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.DiskTypes.Get", + "async": true, + "parameters": [ + { + "name": "disk_type", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.DiskType", + "client": { + "shortName": "DiskTypesClient", + "fullName": "google.cloud.compute.v1.DiskTypesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.DiskTypes.Get", + "service": { + "shortName": "DiskTypes", + "fullName": "google.cloud.compute.v1.DiskTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_DiskTypes_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of disk types available to the specified project.", + "canonical": true, + "file": "disk_types.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.DiskTypes.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.DiskTypeList", + "client": { + "shortName": "DiskTypesClient", + "fullName": "google.cloud.compute.v1.DiskTypesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.DiskTypes.List", + "service": { + "shortName": "DiskTypes", + "fullName": "google.cloud.compute.v1.DiskTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ExternalVpnGateways_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified externalVpnGateway.", + "canonical": true, + "file": "external_vpn_gateways.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.Delete", + "async": true, + "parameters": [ + { + "name": "external_vpn_gateway", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ExternalVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.ExternalVpnGatewaysClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.Delete", + "service": { + "shortName": "ExternalVpnGateways", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ExternalVpnGateways_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.", + "canonical": true, + "file": "external_vpn_gateways.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.Get", + "async": true, + "parameters": [ + { + "name": "external_vpn_gateway", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.ExternalVpnGateway", + "client": { + "shortName": "ExternalVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.ExternalVpnGatewaysClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.Get", + "service": { + "shortName": "ExternalVpnGateways", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ExternalVpnGateways_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a ExternalVpnGateway in the specified project using the data included in the request.", + "canonical": true, + "file": "external_vpn_gateways.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.Insert", + "async": true, + "parameters": [ + { + "name": "external_vpn_gateway_resource", + "type": ".google.cloud.compute.v1.ExternalVpnGateway" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ExternalVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.ExternalVpnGatewaysClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.Insert", + "service": { + "shortName": "ExternalVpnGateways", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ExternalVpnGateways_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of ExternalVpnGateway available to the specified project.", + "canonical": true, + "file": "external_vpn_gateways.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ExternalVpnGatewayList", + "client": { + "shortName": "ExternalVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.ExternalVpnGatewaysClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.List", + "service": { + "shortName": "ExternalVpnGateways", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ExternalVpnGateways_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "external_vpn_gateways.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.SetLabels", + "async": true, + "parameters": [ + { + "name": "global_set_labels_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetLabelsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ExternalVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.ExternalVpnGatewaysClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.SetLabels", + "service": { + "shortName": "ExternalVpnGateways", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ExternalVpnGateways_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "external_vpn_gateways.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "ExternalVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.ExternalVpnGatewaysClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways.TestIamPermissions", + "service": { + "shortName": "ExternalVpnGateways", + "fullName": "google.cloud.compute.v1.ExternalVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_AddAssociation_async", + "title": "AcceleratorTypes addAssociation Sample", + "origin": "API_DEFINITION", + "description": " Inserts an association for the specified firewall policy.", + "canonical": true, + "file": "firewall_policies.add_association.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddAssociation", + "fullName": "google.cloud.compute.v1.FirewallPolicies.AddAssociation", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_association_resource", + "type": ".google.cloud.compute.v1.FirewallPolicyAssociation" + }, + { + "name": "replace_existing_association", + "type": "TYPE_BOOL" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "AddAssociation", + "fullName": "google.cloud.compute.v1.FirewallPolicies.AddAssociation", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_AddRule_async", + "title": "AcceleratorTypes addRule Sample", + "origin": "API_DEFINITION", + "description": " Inserts a rule into a firewall policy.", + "canonical": true, + "file": "firewall_policies.add_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddRule", + "fullName": "google.cloud.compute.v1.FirewallPolicies.AddRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_rule_resource", + "type": ".google.cloud.compute.v1.FirewallPolicyRule" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "AddRule", + "fullName": "google.cloud.compute.v1.FirewallPolicies.AddRule", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_CloneRules_async", + "title": "AcceleratorTypes cloneRules Sample", + "origin": "API_DEFINITION", + "description": " Copies rules to the specified firewall policy.", + "canonical": true, + "file": "firewall_policies.clone_rules.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CloneRules", + "fullName": "google.cloud.compute.v1.FirewallPolicies.CloneRules", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "source_firewall_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "CloneRules", + "fullName": "google.cloud.compute.v1.FirewallPolicies.CloneRules", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified policy.", + "canonical": true, + "file": "firewall_policies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.FirewallPolicies.Delete", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.FirewallPolicies.Delete", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified firewall policy.", + "canonical": true, + "file": "firewall_policies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.FirewallPolicies.Get", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicy", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.FirewallPolicies.Get", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_GetAssociation_async", + "title": "AcceleratorTypes getAssociation Sample", + "origin": "API_DEFINITION", + "description": " Gets an association with the specified name.", + "canonical": true, + "file": "firewall_policies.get_association.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAssociation", + "fullName": "google.cloud.compute.v1.FirewallPolicies.GetAssociation", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicyAssociation", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "GetAssociation", + "fullName": "google.cloud.compute.v1.FirewallPolicies.GetAssociation", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "firewall_policies.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.FirewallPolicies.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.FirewallPolicies.GetIamPolicy", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_GetRule_async", + "title": "AcceleratorTypes getRule Sample", + "origin": "API_DEFINITION", + "description": " Gets a rule of the specified priority.", + "canonical": true, + "file": "firewall_policies.get_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetRule", + "fullName": "google.cloud.compute.v1.FirewallPolicies.GetRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "priority", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicyRule", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "GetRule", + "fullName": "google.cloud.compute.v1.FirewallPolicies.GetRule", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a new policy in the specified project using the data included in the request.", + "canonical": true, + "file": "firewall_policies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.FirewallPolicies.Insert", + "async": true, + "parameters": [ + { + "name": "firewall_policy_resource", + "type": ".google.cloud.compute.v1.FirewallPolicy" + }, + { + "name": "parent_id", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.FirewallPolicies.Insert", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists all the policies that have been configured for the specified folder or organization.", + "canonical": true, + "file": "firewall_policies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.FirewallPolicies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "parent_id", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicyList", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.FirewallPolicies.List", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_ListAssociations_async", + "title": "AcceleratorTypes listAssociations Sample", + "origin": "API_DEFINITION", + "description": " Lists associations of a specified target, i.e., organization or folder.", + "canonical": true, + "file": "firewall_policies.list_associations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 52, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAssociations", + "fullName": "google.cloud.compute.v1.FirewallPolicies.ListAssociations", + "async": true, + "parameters": [ + { + "name": "target_resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPoliciesListAssociationsResponse", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "ListAssociations", + "fullName": "google.cloud.compute.v1.FirewallPolicies.ListAssociations", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_Move_async", + "title": "AcceleratorTypes move Sample", + "origin": "API_DEFINITION", + "description": " Moves the specified firewall policy.", + "canonical": true, + "file": "firewall_policies.move.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Move", + "fullName": "google.cloud.compute.v1.FirewallPolicies.Move", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "parent_id", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "Move", + "fullName": "google.cloud.compute.v1.FirewallPolicies.Move", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified policy with the data included in the request.", + "canonical": true, + "file": "firewall_policies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.FirewallPolicies.Patch", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_resource", + "type": ".google.cloud.compute.v1.FirewallPolicy" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.FirewallPolicies.Patch", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_PatchRule_async", + "title": "AcceleratorTypes patchRule Sample", + "origin": "API_DEFINITION", + "description": " Patches a rule of the specified priority.", + "canonical": true, + "file": "firewall_policies.patch_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PatchRule", + "fullName": "google.cloud.compute.v1.FirewallPolicies.PatchRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_rule_resource", + "type": ".google.cloud.compute.v1.FirewallPolicyRule" + }, + { + "name": "priority", + "type": "TYPE_INT32" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "PatchRule", + "fullName": "google.cloud.compute.v1.FirewallPolicies.PatchRule", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_RemoveAssociation_async", + "title": "AcceleratorTypes removeAssociation Sample", + "origin": "API_DEFINITION", + "description": " Removes an association for the specified firewall policy.", + "canonical": true, + "file": "firewall_policies.remove_association.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveAssociation", + "fullName": "google.cloud.compute.v1.FirewallPolicies.RemoveAssociation", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "RemoveAssociation", + "fullName": "google.cloud.compute.v1.FirewallPolicies.RemoveAssociation", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_RemoveRule_async", + "title": "AcceleratorTypes removeRule Sample", + "origin": "API_DEFINITION", + "description": " Deletes a rule of the specified priority.", + "canonical": true, + "file": "firewall_policies.remove_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveRule", + "fullName": "google.cloud.compute.v1.FirewallPolicies.RemoveRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "priority", + "type": "TYPE_INT32" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "RemoveRule", + "fullName": "google.cloud.compute.v1.FirewallPolicies.RemoveRule", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "firewall_policies.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.FirewallPolicies.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "global_organization_set_policy_request_resource", + "type": ".google.cloud.compute.v1.GlobalOrganizationSetPolicyRequest" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.FirewallPolicies.SetIamPolicy", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_FirewallPolicies_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "firewall_policies.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.FirewallPolicies.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "FirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.FirewallPoliciesClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.FirewallPolicies.TestIamPermissions", + "service": { + "shortName": "FirewallPolicies", + "fullName": "google.cloud.compute.v1.FirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Firewalls_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified firewall.", + "canonical": true, + "file": "firewalls.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Firewalls.Delete", + "async": true, + "parameters": [ + { + "name": "firewall", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallsClient", + "fullName": "google.cloud.compute.v1.FirewallsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Firewalls.Delete", + "service": { + "shortName": "Firewalls", + "fullName": "google.cloud.compute.v1.Firewalls" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Firewalls_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified firewall.", + "canonical": true, + "file": "firewalls.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Firewalls.Get", + "async": true, + "parameters": [ + { + "name": "firewall", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Firewall", + "client": { + "shortName": "FirewallsClient", + "fullName": "google.cloud.compute.v1.FirewallsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Firewalls.Get", + "service": { + "shortName": "Firewalls", + "fullName": "google.cloud.compute.v1.Firewalls" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Firewalls_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a firewall rule in the specified project using the data included in the request.", + "canonical": true, + "file": "firewalls.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Firewalls.Insert", + "async": true, + "parameters": [ + { + "name": "firewall_resource", + "type": ".google.cloud.compute.v1.Firewall" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallsClient", + "fullName": "google.cloud.compute.v1.FirewallsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Firewalls.Insert", + "service": { + "shortName": "Firewalls", + "fullName": "google.cloud.compute.v1.Firewalls" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Firewalls_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of firewall rules available to the specified project.", + "canonical": true, + "file": "firewalls.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Firewalls.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallList", + "client": { + "shortName": "FirewallsClient", + "fullName": "google.cloud.compute.v1.FirewallsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Firewalls.List", + "service": { + "shortName": "Firewalls", + "fullName": "google.cloud.compute.v1.Firewalls" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Firewalls_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "firewalls.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Firewalls.Patch", + "async": true, + "parameters": [ + { + "name": "firewall", + "type": "TYPE_STRING" + }, + { + "name": "firewall_resource", + "type": ".google.cloud.compute.v1.Firewall" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallsClient", + "fullName": "google.cloud.compute.v1.FirewallsClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Firewalls.Patch", + "service": { + "shortName": "Firewalls", + "fullName": "google.cloud.compute.v1.Firewalls" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Firewalls_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.", + "canonical": true, + "file": "firewalls.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Firewalls.Update", + "async": true, + "parameters": [ + { + "name": "firewall", + "type": "TYPE_STRING" + }, + { + "name": "firewall_resource", + "type": ".google.cloud.compute.v1.Firewall" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "FirewallsClient", + "fullName": "google.cloud.compute.v1.FirewallsClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Firewalls.Update", + "service": { + "shortName": "Firewalls", + "fullName": "google.cloud.compute.v1.Firewalls" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ForwardingRules_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of forwarding rules.", + "canonical": true, + "file": "forwarding_rules.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.ForwardingRules.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ForwardingRuleAggregatedList", + "client": { + "shortName": "ForwardingRulesClient", + "fullName": "google.cloud.compute.v1.ForwardingRulesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.ForwardingRules.AggregatedList", + "service": { + "shortName": "ForwardingRules", + "fullName": "google.cloud.compute.v1.ForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ForwardingRules_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified ForwardingRule resource.", + "canonical": true, + "file": "forwarding_rules.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.ForwardingRules.Delete", + "async": true, + "parameters": [ + { + "name": "forwarding_rule", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ForwardingRulesClient", + "fullName": "google.cloud.compute.v1.ForwardingRulesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.ForwardingRules.Delete", + "service": { + "shortName": "ForwardingRules", + "fullName": "google.cloud.compute.v1.ForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ForwardingRules_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified ForwardingRule resource.", + "canonical": true, + "file": "forwarding_rules.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ForwardingRules.Get", + "async": true, + "parameters": [ + { + "name": "forwarding_rule", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.ForwardingRule", + "client": { + "shortName": "ForwardingRulesClient", + "fullName": "google.cloud.compute.v1.ForwardingRulesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ForwardingRules.Get", + "service": { + "shortName": "ForwardingRules", + "fullName": "google.cloud.compute.v1.ForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ForwardingRules_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a ForwardingRule resource in the specified project and region using the data included in the request.", + "canonical": true, + "file": "forwarding_rules.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.ForwardingRules.Insert", + "async": true, + "parameters": [ + { + "name": "forwarding_rule_resource", + "type": ".google.cloud.compute.v1.ForwardingRule" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ForwardingRulesClient", + "fullName": "google.cloud.compute.v1.ForwardingRulesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.ForwardingRules.Insert", + "service": { + "shortName": "ForwardingRules", + "fullName": "google.cloud.compute.v1.ForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ForwardingRules_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of ForwardingRule resources available to the specified project and region.", + "canonical": true, + "file": "forwarding_rules.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.ForwardingRules.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ForwardingRuleList", + "client": { + "shortName": "ForwardingRulesClient", + "fullName": "google.cloud.compute.v1.ForwardingRulesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.ForwardingRules.List", + "service": { + "shortName": "ForwardingRules", + "fullName": "google.cloud.compute.v1.ForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ForwardingRules_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.", + "canonical": true, + "file": "forwarding_rules.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.ForwardingRules.Patch", + "async": true, + "parameters": [ + { + "name": "forwarding_rule", + "type": "TYPE_STRING" + }, + { + "name": "forwarding_rule_resource", + "type": ".google.cloud.compute.v1.ForwardingRule" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ForwardingRulesClient", + "fullName": "google.cloud.compute.v1.ForwardingRulesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.ForwardingRules.Patch", + "service": { + "shortName": "ForwardingRules", + "fullName": "google.cloud.compute.v1.ForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ForwardingRules_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "forwarding_rules.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.ForwardingRules.SetLabels", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_labels_request_resource", + "type": ".google.cloud.compute.v1.RegionSetLabelsRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ForwardingRulesClient", + "fullName": "google.cloud.compute.v1.ForwardingRulesClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.ForwardingRules.SetLabels", + "service": { + "shortName": "ForwardingRules", + "fullName": "google.cloud.compute.v1.ForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ForwardingRules_SetTarget_async", + "title": "AcceleratorTypes setTarget Sample", + "origin": "API_DEFINITION", + "description": " Changes target URL for forwarding rule. The new target should be of the same type as the old target.", + "canonical": true, + "file": "forwarding_rules.set_target.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetTarget", + "fullName": "google.cloud.compute.v1.ForwardingRules.SetTarget", + "async": true, + "parameters": [ + { + "name": "forwarding_rule", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_reference_resource", + "type": ".google.cloud.compute.v1.TargetReference" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ForwardingRulesClient", + "fullName": "google.cloud.compute.v1.ForwardingRulesClient" + }, + "method": { + "shortName": "SetTarget", + "fullName": "google.cloud.compute.v1.ForwardingRules.SetTarget", + "service": { + "shortName": "ForwardingRules", + "fullName": "google.cloud.compute.v1.ForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalAddresses_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified address resource.", + "canonical": true, + "file": "global_addresses.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalAddresses.Delete", + "async": true, + "parameters": [ + { + "name": "address", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalAddressesClient", + "fullName": "google.cloud.compute.v1.GlobalAddressesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalAddresses.Delete", + "service": { + "shortName": "GlobalAddresses", + "fullName": "google.cloud.compute.v1.GlobalAddresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalAddresses_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified address resource.", + "canonical": true, + "file": "global_addresses.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalAddresses.Get", + "async": true, + "parameters": [ + { + "name": "address", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Address", + "client": { + "shortName": "GlobalAddressesClient", + "fullName": "google.cloud.compute.v1.GlobalAddressesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalAddresses.Get", + "service": { + "shortName": "GlobalAddresses", + "fullName": "google.cloud.compute.v1.GlobalAddresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalAddresses_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an address resource in the specified project by using the data included in the request.", + "canonical": true, + "file": "global_addresses.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.GlobalAddresses.Insert", + "async": true, + "parameters": [ + { + "name": "address_resource", + "type": ".google.cloud.compute.v1.Address" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalAddressesClient", + "fullName": "google.cloud.compute.v1.GlobalAddressesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.GlobalAddresses.Insert", + "service": { + "shortName": "GlobalAddresses", + "fullName": "google.cloud.compute.v1.GlobalAddresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalAddresses_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of global addresses.", + "canonical": true, + "file": "global_addresses.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalAddresses.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.AddressList", + "client": { + "shortName": "GlobalAddressesClient", + "fullName": "google.cloud.compute.v1.GlobalAddressesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalAddresses.List", + "service": { + "shortName": "GlobalAddresses", + "fullName": "google.cloud.compute.v1.GlobalAddresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalAddresses_Move_async", + "title": "AcceleratorTypes move Sample", + "origin": "API_DEFINITION", + "description": " Moves the specified address resource from one project to another project.", + "canonical": true, + "file": "global_addresses.move.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Move", + "fullName": "google.cloud.compute.v1.GlobalAddresses.Move", + "async": true, + "parameters": [ + { + "name": "address", + "type": "TYPE_STRING" + }, + { + "name": "global_addresses_move_request_resource", + "type": ".google.cloud.compute.v1.GlobalAddressesMoveRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalAddressesClient", + "fullName": "google.cloud.compute.v1.GlobalAddressesClient" + }, + "method": { + "shortName": "Move", + "fullName": "google.cloud.compute.v1.GlobalAddresses.Move", + "service": { + "shortName": "GlobalAddresses", + "fullName": "google.cloud.compute.v1.GlobalAddresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalAddresses_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "global_addresses.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.GlobalAddresses.SetLabels", + "async": true, + "parameters": [ + { + "name": "global_set_labels_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetLabelsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalAddressesClient", + "fullName": "google.cloud.compute.v1.GlobalAddressesClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.GlobalAddresses.SetLabels", + "service": { + "shortName": "GlobalAddresses", + "fullName": "google.cloud.compute.v1.GlobalAddresses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalForwardingRules_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified GlobalForwardingRule resource.", + "canonical": true, + "file": "global_forwarding_rules.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.Delete", + "async": true, + "parameters": [ + { + "name": "forwarding_rule", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalForwardingRulesClient", + "fullName": "google.cloud.compute.v1.GlobalForwardingRulesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.Delete", + "service": { + "shortName": "GlobalForwardingRules", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalForwardingRules_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.", + "canonical": true, + "file": "global_forwarding_rules.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.Get", + "async": true, + "parameters": [ + { + "name": "forwarding_rule", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.ForwardingRule", + "client": { + "shortName": "GlobalForwardingRulesClient", + "fullName": "google.cloud.compute.v1.GlobalForwardingRulesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.Get", + "service": { + "shortName": "GlobalForwardingRules", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalForwardingRules_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a GlobalForwardingRule resource in the specified project using the data included in the request.", + "canonical": true, + "file": "global_forwarding_rules.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.Insert", + "async": true, + "parameters": [ + { + "name": "forwarding_rule_resource", + "type": ".google.cloud.compute.v1.ForwardingRule" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalForwardingRulesClient", + "fullName": "google.cloud.compute.v1.GlobalForwardingRulesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.Insert", + "service": { + "shortName": "GlobalForwardingRules", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalForwardingRules_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of GlobalForwardingRule resources available to the specified project.", + "canonical": true, + "file": "global_forwarding_rules.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ForwardingRuleList", + "client": { + "shortName": "GlobalForwardingRulesClient", + "fullName": "google.cloud.compute.v1.GlobalForwardingRulesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.List", + "service": { + "shortName": "GlobalForwardingRules", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalForwardingRules_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.", + "canonical": true, + "file": "global_forwarding_rules.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.Patch", + "async": true, + "parameters": [ + { + "name": "forwarding_rule", + "type": "TYPE_STRING" + }, + { + "name": "forwarding_rule_resource", + "type": ".google.cloud.compute.v1.ForwardingRule" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalForwardingRulesClient", + "fullName": "google.cloud.compute.v1.GlobalForwardingRulesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.Patch", + "service": { + "shortName": "GlobalForwardingRules", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalForwardingRules_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.", + "canonical": true, + "file": "global_forwarding_rules.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.SetLabels", + "async": true, + "parameters": [ + { + "name": "global_set_labels_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetLabelsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalForwardingRulesClient", + "fullName": "google.cloud.compute.v1.GlobalForwardingRulesClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.SetLabels", + "service": { + "shortName": "GlobalForwardingRules", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalForwardingRules_SetTarget_async", + "title": "AcceleratorTypes setTarget Sample", + "origin": "API_DEFINITION", + "description": " Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.", + "canonical": true, + "file": "global_forwarding_rules.set_target.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetTarget", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.SetTarget", + "async": true, + "parameters": [ + { + "name": "forwarding_rule", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_reference_resource", + "type": ".google.cloud.compute.v1.TargetReference" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalForwardingRulesClient", + "fullName": "google.cloud.compute.v1.GlobalForwardingRulesClient" + }, + "method": { + "shortName": "SetTarget", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules.SetTarget", + "service": { + "shortName": "GlobalForwardingRules", + "fullName": "google.cloud.compute.v1.GlobalForwardingRules" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalNetworkEndpointGroups_AttachNetworkEndpoints_async", + "title": "AcceleratorTypes attachNetworkEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Attach a network endpoint to the specified network endpoint group.", + "canonical": true, + "file": "global_network_endpoint_groups.attach_network_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AttachNetworkEndpoints", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.AttachNetworkEndpoints", + "async": true, + "parameters": [ + { + "name": "global_network_endpoint_groups_attach_endpoints_request_resource", + "type": ".google.cloud.compute.v1.GlobalNetworkEndpointGroupsAttachEndpointsRequest" + }, + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalNetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroupsClient" + }, + "method": { + "shortName": "AttachNetworkEndpoints", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.AttachNetworkEndpoints", + "service": { + "shortName": "GlobalNetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalNetworkEndpointGroups_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.", + "canonical": true, + "file": "global_network_endpoint_groups.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.Delete", + "async": true, + "parameters": [ + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalNetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroupsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.Delete", + "service": { + "shortName": "GlobalNetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalNetworkEndpointGroups_DetachNetworkEndpoints_async", + "title": "AcceleratorTypes detachNetworkEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Detach the network endpoint from the specified network endpoint group.", + "canonical": true, + "file": "global_network_endpoint_groups.detach_network_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DetachNetworkEndpoints", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.DetachNetworkEndpoints", + "async": true, + "parameters": [ + { + "name": "global_network_endpoint_groups_detach_endpoints_request_resource", + "type": ".google.cloud.compute.v1.GlobalNetworkEndpointGroupsDetachEndpointsRequest" + }, + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalNetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroupsClient" + }, + "method": { + "shortName": "DetachNetworkEndpoints", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.DetachNetworkEndpoints", + "service": { + "shortName": "GlobalNetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalNetworkEndpointGroups_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified network endpoint group.", + "canonical": true, + "file": "global_network_endpoint_groups.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.Get", + "async": true, + "parameters": [ + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkEndpointGroup", + "client": { + "shortName": "GlobalNetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroupsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.Get", + "service": { + "shortName": "GlobalNetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalNetworkEndpointGroups_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a network endpoint group in the specified project using the parameters that are included in the request.", + "canonical": true, + "file": "global_network_endpoint_groups.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.Insert", + "async": true, + "parameters": [ + { + "name": "network_endpoint_group_resource", + "type": ".google.cloud.compute.v1.NetworkEndpointGroup" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalNetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroupsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.Insert", + "service": { + "shortName": "GlobalNetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalNetworkEndpointGroups_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of network endpoint groups that are located in the specified project.", + "canonical": true, + "file": "global_network_endpoint_groups.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkEndpointGroupList", + "client": { + "shortName": "GlobalNetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroupsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.List", + "service": { + "shortName": "GlobalNetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalNetworkEndpointGroups_ListNetworkEndpoints_async", + "title": "AcceleratorTypes listNetworkEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Lists the network endpoints in the specified network endpoint group.", + "canonical": true, + "file": "global_network_endpoint_groups.list_network_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNetworkEndpoints", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.ListNetworkEndpoints", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkEndpointGroupsListNetworkEndpoints", + "client": { + "shortName": "GlobalNetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroupsClient" + }, + "method": { + "shortName": "ListNetworkEndpoints", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups.ListNetworkEndpoints", + "service": { + "shortName": "GlobalNetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.GlobalNetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalOperations_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of all operations.", + "canonical": true, + "file": "global_operations.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.GlobalOperations.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.OperationAggregatedList", + "client": { + "shortName": "GlobalOperationsClient", + "fullName": "google.cloud.compute.v1.GlobalOperationsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.GlobalOperations.AggregatedList", + "service": { + "shortName": "GlobalOperations", + "fullName": "google.cloud.compute.v1.GlobalOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalOperations_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified Operations resource.", + "canonical": true, + "file": "global_operations.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalOperations.Delete", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.DeleteGlobalOperationResponse", + "client": { + "shortName": "GlobalOperationsClient", + "fullName": "google.cloud.compute.v1.GlobalOperationsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalOperations.Delete", + "service": { + "shortName": "GlobalOperations", + "fullName": "google.cloud.compute.v1.GlobalOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalOperations_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the specified Operations resource.", + "canonical": true, + "file": "global_operations.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalOperations.Get", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalOperationsClient", + "fullName": "google.cloud.compute.v1.GlobalOperationsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalOperations.Get", + "service": { + "shortName": "GlobalOperations", + "fullName": "google.cloud.compute.v1.GlobalOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalOperations_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of Operation resources contained within the specified project.", + "canonical": true, + "file": "global_operations.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalOperations.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.OperationList", + "client": { + "shortName": "GlobalOperationsClient", + "fullName": "google.cloud.compute.v1.GlobalOperationsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalOperations.List", + "service": { + "shortName": "GlobalOperations", + "fullName": "google.cloud.compute.v1.GlobalOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalOperations_Wait_async", + "title": "AcceleratorTypes wait Sample", + "origin": "API_DEFINITION", + "description": " Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", + "canonical": true, + "file": "global_operations.wait.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Wait", + "fullName": "google.cloud.compute.v1.GlobalOperations.Wait", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalOperationsClient", + "fullName": "google.cloud.compute.v1.GlobalOperationsClient" + }, + "method": { + "shortName": "Wait", + "fullName": "google.cloud.compute.v1.GlobalOperations.Wait", + "service": { + "shortName": "GlobalOperations", + "fullName": "google.cloud.compute.v1.GlobalOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalOrganizationOperations_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified Operations resource.", + "canonical": true, + "file": "global_organization_operations.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperations.Delete", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "parent_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.DeleteGlobalOrganizationOperationResponse", + "client": { + "shortName": "GlobalOrganizationOperationsClient", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperationsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperations.Delete", + "service": { + "shortName": "GlobalOrganizationOperations", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalOrganizationOperations_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.", + "canonical": true, + "file": "global_organization_operations.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperations.Get", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "parent_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalOrganizationOperationsClient", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperationsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperations.Get", + "service": { + "shortName": "GlobalOrganizationOperations", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalOrganizationOperations_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of Operation resources contained within the specified organization.", + "canonical": true, + "file": "global_organization_operations.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperations.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "parent_id", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.OperationList", + "client": { + "shortName": "GlobalOrganizationOperationsClient", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperationsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperations.List", + "service": { + "shortName": "GlobalOrganizationOperations", + "fullName": "google.cloud.compute.v1.GlobalOrganizationOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalPublicDelegatedPrefixes_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified global PublicDelegatedPrefix.", + "canonical": true, + "file": "global_public_delegated_prefixes.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_delegated_prefix", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalPublicDelegatedPrefixesClient", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes.Delete", + "service": { + "shortName": "GlobalPublicDelegatedPrefixes", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalPublicDelegatedPrefixes_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified global PublicDelegatedPrefix resource.", + "canonical": true, + "file": "global_public_delegated_prefixes.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_delegated_prefix", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.PublicDelegatedPrefix", + "client": { + "shortName": "GlobalPublicDelegatedPrefixesClient", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes.Get", + "service": { + "shortName": "GlobalPublicDelegatedPrefixes", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalPublicDelegatedPrefixes_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.", + "canonical": true, + "file": "global_public_delegated_prefixes.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_delegated_prefix_resource", + "type": ".google.cloud.compute.v1.PublicDelegatedPrefix" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalPublicDelegatedPrefixesClient", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes.Insert", + "service": { + "shortName": "GlobalPublicDelegatedPrefixes", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalPublicDelegatedPrefixes_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists the global PublicDelegatedPrefixes for a project.", + "canonical": true, + "file": "global_public_delegated_prefixes.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.PublicDelegatedPrefixList", + "client": { + "shortName": "GlobalPublicDelegatedPrefixesClient", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes.List", + "service": { + "shortName": "GlobalPublicDelegatedPrefixes", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_GlobalPublicDelegatedPrefixes_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "canonical": true, + "file": "global_public_delegated_prefixes.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_delegated_prefix", + "type": "TYPE_STRING" + }, + { + "name": "public_delegated_prefix_resource", + "type": ".google.cloud.compute.v1.PublicDelegatedPrefix" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "GlobalPublicDelegatedPrefixesClient", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes.Patch", + "service": { + "shortName": "GlobalPublicDelegatedPrefixes", + "fullName": "google.cloud.compute.v1.GlobalPublicDelegatedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_HealthChecks_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.", + "canonical": true, + "file": "health_checks.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.HealthChecks.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.HealthChecksAggregatedList", + "client": { + "shortName": "HealthChecksClient", + "fullName": "google.cloud.compute.v1.HealthChecksClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.HealthChecks.AggregatedList", + "service": { + "shortName": "HealthChecks", + "fullName": "google.cloud.compute.v1.HealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_HealthChecks_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified HealthCheck resource.", + "canonical": true, + "file": "health_checks.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.HealthChecks.Delete", + "async": true, + "parameters": [ + { + "name": "health_check", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "HealthChecksClient", + "fullName": "google.cloud.compute.v1.HealthChecksClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.HealthChecks.Delete", + "service": { + "shortName": "HealthChecks", + "fullName": "google.cloud.compute.v1.HealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_HealthChecks_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified HealthCheck resource.", + "canonical": true, + "file": "health_checks.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.HealthChecks.Get", + "async": true, + "parameters": [ + { + "name": "health_check", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.HealthCheck", + "client": { + "shortName": "HealthChecksClient", + "fullName": "google.cloud.compute.v1.HealthChecksClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.HealthChecks.Get", + "service": { + "shortName": "HealthChecks", + "fullName": "google.cloud.compute.v1.HealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_HealthChecks_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a HealthCheck resource in the specified project using the data included in the request.", + "canonical": true, + "file": "health_checks.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.HealthChecks.Insert", + "async": true, + "parameters": [ + { + "name": "health_check_resource", + "type": ".google.cloud.compute.v1.HealthCheck" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "HealthChecksClient", + "fullName": "google.cloud.compute.v1.HealthChecksClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.HealthChecks.Insert", + "service": { + "shortName": "HealthChecks", + "fullName": "google.cloud.compute.v1.HealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_HealthChecks_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of HealthCheck resources available to the specified project.", + "canonical": true, + "file": "health_checks.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.HealthChecks.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.HealthCheckList", + "client": { + "shortName": "HealthChecksClient", + "fullName": "google.cloud.compute.v1.HealthChecksClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.HealthChecks.List", + "service": { + "shortName": "HealthChecks", + "fullName": "google.cloud.compute.v1.HealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_HealthChecks_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "health_checks.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.HealthChecks.Patch", + "async": true, + "parameters": [ + { + "name": "health_check", + "type": "TYPE_STRING" + }, + { + "name": "health_check_resource", + "type": ".google.cloud.compute.v1.HealthCheck" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "HealthChecksClient", + "fullName": "google.cloud.compute.v1.HealthChecksClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.HealthChecks.Patch", + "service": { + "shortName": "HealthChecks", + "fullName": "google.cloud.compute.v1.HealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_HealthChecks_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates a HealthCheck resource in the specified project using the data included in the request.", + "canonical": true, + "file": "health_checks.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.HealthChecks.Update", + "async": true, + "parameters": [ + { + "name": "health_check", + "type": "TYPE_STRING" + }, + { + "name": "health_check_resource", + "type": ".google.cloud.compute.v1.HealthCheck" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "HealthChecksClient", + "fullName": "google.cloud.compute.v1.HealthChecksClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.HealthChecks.Update", + "service": { + "shortName": "HealthChecks", + "fullName": "google.cloud.compute.v1.HealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ImageFamilyViews_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.", + "canonical": true, + "file": "image_family_views.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ImageFamilyViews.Get", + "async": true, + "parameters": [ + { + "name": "family", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.ImageFamilyView", + "client": { + "shortName": "ImageFamilyViewsClient", + "fullName": "google.cloud.compute.v1.ImageFamilyViewsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ImageFamilyViews.Get", + "service": { + "shortName": "ImageFamilyViews", + "fullName": "google.cloud.compute.v1.ImageFamilyViews" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Images_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified image.", + "canonical": true, + "file": "images.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Images.Delete", + "async": true, + "parameters": [ + { + "name": "image", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ImagesClient", + "fullName": "google.cloud.compute.v1.ImagesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Images.Delete", + "service": { + "shortName": "Images", + "fullName": "google.cloud.compute.v1.Images" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Images_Deprecate_async", + "title": "AcceleratorTypes deprecate Sample", + "origin": "API_DEFINITION", + "description": " Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.", + "canonical": true, + "file": "images.deprecate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Deprecate", + "fullName": "google.cloud.compute.v1.Images.Deprecate", + "async": true, + "parameters": [ + { + "name": "deprecation_status_resource", + "type": ".google.cloud.compute.v1.DeprecationStatus" + }, + { + "name": "image", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ImagesClient", + "fullName": "google.cloud.compute.v1.ImagesClient" + }, + "method": { + "shortName": "Deprecate", + "fullName": "google.cloud.compute.v1.Images.Deprecate", + "service": { + "shortName": "Images", + "fullName": "google.cloud.compute.v1.Images" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Images_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified image.", + "canonical": true, + "file": "images.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Images.Get", + "async": true, + "parameters": [ + { + "name": "image", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Image", + "client": { + "shortName": "ImagesClient", + "fullName": "google.cloud.compute.v1.ImagesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Images.Get", + "service": { + "shortName": "Images", + "fullName": "google.cloud.compute.v1.Images" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Images_GetFromFamily_async", + "title": "AcceleratorTypes getFromFamily Sample", + "origin": "API_DEFINITION", + "description": " Returns the latest image that is part of an image family and is not deprecated. For more information on image families, see Public image families documentation.", + "canonical": true, + "file": "images.get_from_family.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetFromFamily", + "fullName": "google.cloud.compute.v1.Images.GetFromFamily", + "async": true, + "parameters": [ + { + "name": "family", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Image", + "client": { + "shortName": "ImagesClient", + "fullName": "google.cloud.compute.v1.ImagesClient" + }, + "method": { + "shortName": "GetFromFamily", + "fullName": "google.cloud.compute.v1.Images.GetFromFamily", + "service": { + "shortName": "Images", + "fullName": "google.cloud.compute.v1.Images" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Images_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "images.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Images.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "ImagesClient", + "fullName": "google.cloud.compute.v1.ImagesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Images.GetIamPolicy", + "service": { + "shortName": "Images", + "fullName": "google.cloud.compute.v1.Images" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Images_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an image in the specified project using the data included in the request.", + "canonical": true, + "file": "images.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Images.Insert", + "async": true, + "parameters": [ + { + "name": "force_create", + "type": "TYPE_BOOL" + }, + { + "name": "image_resource", + "type": ".google.cloud.compute.v1.Image" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ImagesClient", + "fullName": "google.cloud.compute.v1.ImagesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Images.Insert", + "service": { + "shortName": "Images", + "fullName": "google.cloud.compute.v1.Images" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Images_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.", + "canonical": true, + "file": "images.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Images.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ImageList", + "client": { + "shortName": "ImagesClient", + "fullName": "google.cloud.compute.v1.ImagesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Images.List", + "service": { + "shortName": "Images", + "fullName": "google.cloud.compute.v1.Images" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Images_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.", + "canonical": true, + "file": "images.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Images.Patch", + "async": true, + "parameters": [ + { + "name": "image", + "type": "TYPE_STRING" + }, + { + "name": "image_resource", + "type": ".google.cloud.compute.v1.Image" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ImagesClient", + "fullName": "google.cloud.compute.v1.ImagesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Images.Patch", + "service": { + "shortName": "Images", + "fullName": "google.cloud.compute.v1.Images" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Images_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "images.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Images.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "global_set_policy_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetPolicyRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "ImagesClient", + "fullName": "google.cloud.compute.v1.ImagesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Images.SetIamPolicy", + "service": { + "shortName": "Images", + "fullName": "google.cloud.compute.v1.Images" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Images_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "images.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Images.SetLabels", + "async": true, + "parameters": [ + { + "name": "global_set_labels_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetLabelsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ImagesClient", + "fullName": "google.cloud.compute.v1.ImagesClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Images.SetLabels", + "service": { + "shortName": "Images", + "fullName": "google.cloud.compute.v1.Images" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Images_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "images.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Images.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "ImagesClient", + "fullName": "google.cloud.compute.v1.ImagesClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Images.TestIamPermissions", + "service": { + "shortName": "Images", + "fullName": "google.cloud.compute.v1.Images" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_AbandonInstances_async", + "title": "AcceleratorTypes abandonInstances Sample", + "origin": "API_DEFINITION", + "description": " Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.", + "canonical": true, + "file": "instance_group_managers.abandon_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AbandonInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.AbandonInstances", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_managers_abandon_instances_request_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManagersAbandonInstancesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "AbandonInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.AbandonInstances", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of managed instance groups and groups them by zone.", + "canonical": true, + "file": "instance_group_managers.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroupManagerAggregatedList", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.AggregatedList", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_ApplyUpdatesToInstances_async", + "title": "AcceleratorTypes applyUpdatesToInstances Sample", + "origin": "API_DEFINITION", + "description": " Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.", + "canonical": true, + "file": "instance_group_managers.apply_updates_to_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ApplyUpdatesToInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.ApplyUpdatesToInstances", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_managers_apply_updates_request_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManagersApplyUpdatesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "ApplyUpdatesToInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.ApplyUpdatesToInstances", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_CreateInstances_async", + "title": "AcceleratorTypes createInstances Sample", + "origin": "API_DEFINITION", + "description": " Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.", + "canonical": true, + "file": "instance_group_managers.create_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.CreateInstances", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_managers_create_instances_request_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManagersCreateInstancesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "CreateInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.CreateInstances", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.", + "canonical": true, + "file": "instance_group_managers.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.Delete", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.Delete", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_DeleteInstances_async", + "title": "AcceleratorTypes deleteInstances Sample", + "origin": "API_DEFINITION", + "description": " Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.", + "canonical": true, + "file": "instance_group_managers.delete_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.DeleteInstances", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_managers_delete_instances_request_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManagersDeleteInstancesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "DeleteInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.DeleteInstances", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_DeletePerInstanceConfigs_async", + "title": "AcceleratorTypes deletePerInstanceConfigs Sample", + "origin": "API_DEFINITION", + "description": " Deletes selected per-instance configurations for the managed instance group.", + "canonical": true, + "file": "instance_group_managers.delete_per_instance_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeletePerInstanceConfigs", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.DeletePerInstanceConfigs", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_managers_delete_per_instance_configs_req_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManagersDeletePerInstanceConfigsReq" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "DeletePerInstanceConfigs", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.DeletePerInstanceConfigs", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns all of the details about the specified managed instance group.", + "canonical": true, + "file": "instance_group_managers.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.Get", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroupManager", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.Get", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.", + "canonical": true, + "file": "instance_group_managers.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.Insert", + "async": true, + "parameters": [ + { + "name": "instance_group_manager_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManager" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.Insert", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of managed instance groups that are contained within the specified project and zone.", + "canonical": true, + "file": "instance_group_managers.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroupManagerList", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.List", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_ListErrors_async", + "title": "AcceleratorTypes listErrors Sample", + "origin": "API_DEFINITION", + "description": " Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.", + "canonical": true, + "file": "instance_group_managers.list_errors.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListErrors", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.ListErrors", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroupManagersListErrorsResponse", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "ListErrors", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.ListErrors", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_ListManagedInstances_async", + "title": "AcceleratorTypes listManagedInstances Sample", + "origin": "API_DEFINITION", + "description": " Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.", + "canonical": true, + "file": "instance_group_managers.list_managed_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListManagedInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.ListManagedInstances", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroupManagersListManagedInstancesResponse", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "ListManagedInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.ListManagedInstances", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_ListPerInstanceConfigs_async", + "title": "AcceleratorTypes listPerInstanceConfigs Sample", + "origin": "API_DEFINITION", + "description": " Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.", + "canonical": true, + "file": "instance_group_managers.list_per_instance_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPerInstanceConfigs", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.ListPerInstanceConfigs", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroupManagersListPerInstanceConfigsResp", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "ListPerInstanceConfigs", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.ListPerInstanceConfigs", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.", + "canonical": true, + "file": "instance_group_managers.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.Patch", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_manager_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManager" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.Patch", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_PatchPerInstanceConfigs_async", + "title": "AcceleratorTypes patchPerInstanceConfigs Sample", + "origin": "API_DEFINITION", + "description": " Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.", + "canonical": true, + "file": "instance_group_managers.patch_per_instance_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PatchPerInstanceConfigs", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.PatchPerInstanceConfigs", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_managers_patch_per_instance_configs_req_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManagersPatchPerInstanceConfigsReq" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "PatchPerInstanceConfigs", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.PatchPerInstanceConfigs", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_RecreateInstances_async", + "title": "AcceleratorTypes recreateInstances Sample", + "origin": "API_DEFINITION", + "description": " Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.", + "canonical": true, + "file": "instance_group_managers.recreate_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RecreateInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.RecreateInstances", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_managers_recreate_instances_request_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManagersRecreateInstancesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "RecreateInstances", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.RecreateInstances", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_Resize_async", + "title": "AcceleratorTypes resize Sample", + "origin": "API_DEFINITION", + "description": " Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.", + "canonical": true, + "file": "instance_group_managers.resize.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Resize", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.Resize", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "size", + "type": "TYPE_INT32" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "Resize", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.Resize", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_SetInstanceTemplate_async", + "title": "AcceleratorTypes setInstanceTemplate Sample", + "origin": "API_DEFINITION", + "description": " Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.", + "canonical": true, + "file": "instance_group_managers.set_instance_template.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetInstanceTemplate", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.SetInstanceTemplate", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_managers_set_instance_template_request_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManagersSetInstanceTemplateRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "SetInstanceTemplate", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.SetInstanceTemplate", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_SetTargetPools_async", + "title": "AcceleratorTypes setTargetPools Sample", + "origin": "API_DEFINITION", + "description": " Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.", + "canonical": true, + "file": "instance_group_managers.set_target_pools.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetTargetPools", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.SetTargetPools", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_managers_set_target_pools_request_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManagersSetTargetPoolsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "SetTargetPools", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.SetTargetPools", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroupManagers_UpdatePerInstanceConfigs_async", + "title": "AcceleratorTypes updatePerInstanceConfigs Sample", + "origin": "API_DEFINITION", + "description": " Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.", + "canonical": true, + "file": "instance_group_managers.update_per_instance_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdatePerInstanceConfigs", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.UpdatePerInstanceConfigs", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_managers_update_per_instance_configs_req_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManagersUpdatePerInstanceConfigsReq" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.InstanceGroupManagersClient" + }, + "method": { + "shortName": "UpdatePerInstanceConfigs", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers.UpdatePerInstanceConfigs", + "service": { + "shortName": "InstanceGroupManagers", + "fullName": "google.cloud.compute.v1.InstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroups_AddInstances_async", + "title": "AcceleratorTypes addInstances Sample", + "origin": "API_DEFINITION", + "description": " Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.", + "canonical": true, + "file": "instance_groups.add_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddInstances", + "fullName": "google.cloud.compute.v1.InstanceGroups.AddInstances", + "async": true, + "parameters": [ + { + "name": "instance_group", + "type": "TYPE_STRING" + }, + { + "name": "instance_groups_add_instances_request_resource", + "type": ".google.cloud.compute.v1.InstanceGroupsAddInstancesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupsClient", + "fullName": "google.cloud.compute.v1.InstanceGroupsClient" + }, + "method": { + "shortName": "AddInstances", + "fullName": "google.cloud.compute.v1.InstanceGroups.AddInstances", + "service": { + "shortName": "InstanceGroups", + "fullName": "google.cloud.compute.v1.InstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroups_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of instance groups and sorts them by zone.", + "canonical": true, + "file": "instance_groups.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.InstanceGroups.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroupAggregatedList", + "client": { + "shortName": "InstanceGroupsClient", + "fullName": "google.cloud.compute.v1.InstanceGroupsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.InstanceGroups.AggregatedList", + "service": { + "shortName": "InstanceGroups", + "fullName": "google.cloud.compute.v1.InstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroups_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.", + "canonical": true, + "file": "instance_groups.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.InstanceGroups.Delete", + "async": true, + "parameters": [ + { + "name": "instance_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupsClient", + "fullName": "google.cloud.compute.v1.InstanceGroupsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.InstanceGroups.Delete", + "service": { + "shortName": "InstanceGroups", + "fullName": "google.cloud.compute.v1.InstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroups_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.", + "canonical": true, + "file": "instance_groups.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InstanceGroups.Get", + "async": true, + "parameters": [ + { + "name": "instance_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroup", + "client": { + "shortName": "InstanceGroupsClient", + "fullName": "google.cloud.compute.v1.InstanceGroupsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InstanceGroups.Get", + "service": { + "shortName": "InstanceGroups", + "fullName": "google.cloud.compute.v1.InstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroups_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an instance group in the specified project using the parameters that are included in the request.", + "canonical": true, + "file": "instance_groups.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.InstanceGroups.Insert", + "async": true, + "parameters": [ + { + "name": "instance_group_resource", + "type": ".google.cloud.compute.v1.InstanceGroup" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupsClient", + "fullName": "google.cloud.compute.v1.InstanceGroupsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.InstanceGroups.Insert", + "service": { + "shortName": "InstanceGroups", + "fullName": "google.cloud.compute.v1.InstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroups_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.", + "canonical": true, + "file": "instance_groups.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InstanceGroups.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroupList", + "client": { + "shortName": "InstanceGroupsClient", + "fullName": "google.cloud.compute.v1.InstanceGroupsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InstanceGroups.List", + "service": { + "shortName": "InstanceGroups", + "fullName": "google.cloud.compute.v1.InstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroups_ListInstances_async", + "title": "AcceleratorTypes listInstances Sample", + "origin": "API_DEFINITION", + "description": " Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use `eq` (equal) or `ne` (not equal) operators.", + "canonical": true, + "file": "instance_groups.list_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListInstances", + "fullName": "google.cloud.compute.v1.InstanceGroups.ListInstances", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "instance_group", + "type": "TYPE_STRING" + }, + { + "name": "instance_groups_list_instances_request_resource", + "type": ".google.cloud.compute.v1.InstanceGroupsListInstancesRequest" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroupsListInstances", + "client": { + "shortName": "InstanceGroupsClient", + "fullName": "google.cloud.compute.v1.InstanceGroupsClient" + }, + "method": { + "shortName": "ListInstances", + "fullName": "google.cloud.compute.v1.InstanceGroups.ListInstances", + "service": { + "shortName": "InstanceGroups", + "fullName": "google.cloud.compute.v1.InstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroups_RemoveInstances_async", + "title": "AcceleratorTypes removeInstances Sample", + "origin": "API_DEFINITION", + "description": " Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.", + "canonical": true, + "file": "instance_groups.remove_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveInstances", + "fullName": "google.cloud.compute.v1.InstanceGroups.RemoveInstances", + "async": true, + "parameters": [ + { + "name": "instance_group", + "type": "TYPE_STRING" + }, + { + "name": "instance_groups_remove_instances_request_resource", + "type": ".google.cloud.compute.v1.InstanceGroupsRemoveInstancesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupsClient", + "fullName": "google.cloud.compute.v1.InstanceGroupsClient" + }, + "method": { + "shortName": "RemoveInstances", + "fullName": "google.cloud.compute.v1.InstanceGroups.RemoveInstances", + "service": { + "shortName": "InstanceGroups", + "fullName": "google.cloud.compute.v1.InstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceGroups_SetNamedPorts_async", + "title": "AcceleratorTypes setNamedPorts Sample", + "origin": "API_DEFINITION", + "description": " Sets the named ports for the specified instance group.", + "canonical": true, + "file": "instance_groups.set_named_ports.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetNamedPorts", + "fullName": "google.cloud.compute.v1.InstanceGroups.SetNamedPorts", + "async": true, + "parameters": [ + { + "name": "instance_group", + "type": "TYPE_STRING" + }, + { + "name": "instance_groups_set_named_ports_request_resource", + "type": ".google.cloud.compute.v1.InstanceGroupsSetNamedPortsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceGroupsClient", + "fullName": "google.cloud.compute.v1.InstanceGroupsClient" + }, + "method": { + "shortName": "SetNamedPorts", + "fullName": "google.cloud.compute.v1.InstanceGroups.SetNamedPorts", + "service": { + "shortName": "InstanceGroups", + "fullName": "google.cloud.compute.v1.InstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_AddAccessConfig_async", + "title": "AcceleratorTypes addAccessConfig Sample", + "origin": "API_DEFINITION", + "description": " Adds an access config to an instance's network interface.", + "canonical": true, + "file": "instances.add_access_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddAccessConfig", + "fullName": "google.cloud.compute.v1.Instances.AddAccessConfig", + "async": true, + "parameters": [ + { + "name": "access_config_resource", + "type": ".google.cloud.compute.v1.AccessConfig" + }, + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "network_interface", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "AddAccessConfig", + "fullName": "google.cloud.compute.v1.Instances.AddAccessConfig", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_AddResourcePolicies_async", + "title": "AcceleratorTypes addResourcePolicies Sample", + "origin": "API_DEFINITION", + "description": " Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.", + "canonical": true, + "file": "instances.add_resource_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddResourcePolicies", + "fullName": "google.cloud.compute.v1.Instances.AddResourcePolicies", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "instances_add_resource_policies_request_resource", + "type": ".google.cloud.compute.v1.InstancesAddResourcePoliciesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "AddResourcePolicies", + "fullName": "google.cloud.compute.v1.Instances.AddResourcePolicies", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.", + "canonical": true, + "file": "instances.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Instances.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceAggregatedList", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Instances.AggregatedList", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_AttachDisk_async", + "title": "AcceleratorTypes attachDisk Sample", + "origin": "API_DEFINITION", + "description": " Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.", + "canonical": true, + "file": "instances.attach_disk.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AttachDisk", + "fullName": "google.cloud.compute.v1.Instances.AttachDisk", + "async": true, + "parameters": [ + { + "name": "attached_disk_resource", + "type": ".google.cloud.compute.v1.AttachedDisk" + }, + { + "name": "force_attach", + "type": "TYPE_BOOL" + }, + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "AttachDisk", + "fullName": "google.cloud.compute.v1.Instances.AttachDisk", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_BulkInsert_async", + "title": "AcceleratorTypes bulkInsert Sample", + "origin": "API_DEFINITION", + "description": " Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.", + "canonical": true, + "file": "instances.bulk_insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BulkInsert", + "fullName": "google.cloud.compute.v1.Instances.BulkInsert", + "async": true, + "parameters": [ + { + "name": "bulk_insert_instance_resource_resource", + "type": ".google.cloud.compute.v1.BulkInsertInstanceResource" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "BulkInsert", + "fullName": "google.cloud.compute.v1.Instances.BulkInsert", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified Instance resource. For more information, see Deleting an instance.", + "canonical": true, + "file": "instances.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Instances.Delete", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Instances.Delete", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_DeleteAccessConfig_async", + "title": "AcceleratorTypes deleteAccessConfig Sample", + "origin": "API_DEFINITION", + "description": " Deletes an access config from an instance's network interface.", + "canonical": true, + "file": "instances.delete_access_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAccessConfig", + "fullName": "google.cloud.compute.v1.Instances.DeleteAccessConfig", + "async": true, + "parameters": [ + { + "name": "access_config", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "network_interface", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "DeleteAccessConfig", + "fullName": "google.cloud.compute.v1.Instances.DeleteAccessConfig", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_DetachDisk_async", + "title": "AcceleratorTypes detachDisk Sample", + "origin": "API_DEFINITION", + "description": " Detaches a disk from an instance.", + "canonical": true, + "file": "instances.detach_disk.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DetachDisk", + "fullName": "google.cloud.compute.v1.Instances.DetachDisk", + "async": true, + "parameters": [ + { + "name": "device_name", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "DetachDisk", + "fullName": "google.cloud.compute.v1.Instances.DetachDisk", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified Instance resource.", + "canonical": true, + "file": "instances.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Instances.Get", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Instance", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Instances.Get", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_GetEffectiveFirewalls_async", + "title": "AcceleratorTypes getEffectiveFirewalls Sample", + "origin": "API_DEFINITION", + "description": " Returns effective firewalls applied to an interface of the instance.", + "canonical": true, + "file": "instances.get_effective_firewalls.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEffectiveFirewalls", + "fullName": "google.cloud.compute.v1.Instances.GetEffectiveFirewalls", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "network_interface", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstancesGetEffectiveFirewallsResponse", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "GetEffectiveFirewalls", + "fullName": "google.cloud.compute.v1.Instances.GetEffectiveFirewalls", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_GetGuestAttributes_async", + "title": "AcceleratorTypes getGuestAttributes Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified guest attributes entry.", + "canonical": true, + "file": "instances.get_guest_attributes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetGuestAttributes", + "fullName": "google.cloud.compute.v1.Instances.GetGuestAttributes", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "query_path", + "type": "TYPE_STRING" + }, + { + "name": "variable_key", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.GuestAttributes", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "GetGuestAttributes", + "fullName": "google.cloud.compute.v1.Instances.GetGuestAttributes", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "instances.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Instances.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Instances.GetIamPolicy", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_GetScreenshot_async", + "title": "AcceleratorTypes getScreenshot Sample", + "origin": "API_DEFINITION", + "description": " Returns the screenshot from the specified instance.", + "canonical": true, + "file": "instances.get_screenshot.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetScreenshot", + "fullName": "google.cloud.compute.v1.Instances.GetScreenshot", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Screenshot", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "GetScreenshot", + "fullName": "google.cloud.compute.v1.Instances.GetScreenshot", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_GetSerialPortOutput_async", + "title": "AcceleratorTypes getSerialPortOutput Sample", + "origin": "API_DEFINITION", + "description": " Returns the last 1 MB of serial port output from the specified instance.", + "canonical": true, + "file": "instances.get_serial_port_output.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSerialPortOutput", + "fullName": "google.cloud.compute.v1.Instances.GetSerialPortOutput", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "port", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "start", + "type": "TYPE_INT64" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.SerialPortOutput", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "GetSerialPortOutput", + "fullName": "google.cloud.compute.v1.Instances.GetSerialPortOutput", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_GetShieldedInstanceIdentity_async", + "title": "AcceleratorTypes getShieldedInstanceIdentity Sample", + "origin": "API_DEFINITION", + "description": " Returns the Shielded Instance Identity of an instance", + "canonical": true, + "file": "instances.get_shielded_instance_identity.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetShieldedInstanceIdentity", + "fullName": "google.cloud.compute.v1.Instances.GetShieldedInstanceIdentity", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.ShieldedInstanceIdentity", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "GetShieldedInstanceIdentity", + "fullName": "google.cloud.compute.v1.Instances.GetShieldedInstanceIdentity", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an instance resource in the specified project using the data included in the request.", + "canonical": true, + "file": "instances.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Instances.Insert", + "async": true, + "parameters": [ + { + "name": "instance_resource", + "type": ".google.cloud.compute.v1.Instance" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "source_instance_template", + "type": "TYPE_STRING" + }, + { + "name": "source_machine_image", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Instances.Insert", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of instances contained within the specified zone.", + "canonical": true, + "file": "instances.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Instances.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceList", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Instances.List", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_ListReferrers_async", + "title": "AcceleratorTypes listReferrers Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.", + "canonical": true, + "file": "instances.list_referrers.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListReferrers", + "fullName": "google.cloud.compute.v1.Instances.ListReferrers", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceListReferrers", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "ListReferrers", + "fullName": "google.cloud.compute.v1.Instances.ListReferrers", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_RemoveResourcePolicies_async", + "title": "AcceleratorTypes removeResourcePolicies Sample", + "origin": "API_DEFINITION", + "description": " Removes resource policies from an instance.", + "canonical": true, + "file": "instances.remove_resource_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveResourcePolicies", + "fullName": "google.cloud.compute.v1.Instances.RemoveResourcePolicies", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "instances_remove_resource_policies_request_resource", + "type": ".google.cloud.compute.v1.InstancesRemoveResourcePoliciesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "RemoveResourcePolicies", + "fullName": "google.cloud.compute.v1.Instances.RemoveResourcePolicies", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_Reset_async", + "title": "AcceleratorTypes reset Sample", + "origin": "API_DEFINITION", + "description": " Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.", + "canonical": true, + "file": "instances.reset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Reset", + "fullName": "google.cloud.compute.v1.Instances.Reset", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "Reset", + "fullName": "google.cloud.compute.v1.Instances.Reset", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_Resume_async", + "title": "AcceleratorTypes resume Sample", + "origin": "API_DEFINITION", + "description": " Resumes an instance that was suspended using the instances().suspend method.", + "canonical": true, + "file": "instances.resume.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Resume", + "fullName": "google.cloud.compute.v1.Instances.Resume", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "Resume", + "fullName": "google.cloud.compute.v1.Instances.Resume", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SendDiagnosticInterrupt_async", + "title": "AcceleratorTypes sendDiagnosticInterrupt Sample", + "origin": "API_DEFINITION", + "description": " Sends diagnostic interrupt to the instance.", + "canonical": true, + "file": "instances.send_diagnostic_interrupt.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SendDiagnosticInterrupt", + "fullName": "google.cloud.compute.v1.Instances.SendDiagnosticInterrupt", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.SendDiagnosticInterruptInstanceResponse", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SendDiagnosticInterrupt", + "fullName": "google.cloud.compute.v1.Instances.SendDiagnosticInterrupt", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetDeletionProtection_async", + "title": "AcceleratorTypes setDeletionProtection Sample", + "origin": "API_DEFINITION", + "description": " Sets deletion protection on the instance.", + "canonical": true, + "file": "instances.set_deletion_protection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetDeletionProtection", + "fullName": "google.cloud.compute.v1.Instances.SetDeletionProtection", + "async": true, + "parameters": [ + { + "name": "deletion_protection", + "type": "TYPE_BOOL" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetDeletionProtection", + "fullName": "google.cloud.compute.v1.Instances.SetDeletionProtection", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetDiskAutoDelete_async", + "title": "AcceleratorTypes setDiskAutoDelete Sample", + "origin": "API_DEFINITION", + "description": " Sets the auto-delete flag for a disk attached to an instance.", + "canonical": true, + "file": "instances.set_disk_auto_delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetDiskAutoDelete", + "fullName": "google.cloud.compute.v1.Instances.SetDiskAutoDelete", + "async": true, + "parameters": [ + { + "name": "auto_delete", + "type": "TYPE_BOOL" + }, + { + "name": "device_name", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetDiskAutoDelete", + "fullName": "google.cloud.compute.v1.Instances.SetDiskAutoDelete", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "instances.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Instances.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + }, + { + "name": "zone_set_policy_request_resource", + "type": ".google.cloud.compute.v1.ZoneSetPolicyRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Instances.SetIamPolicy", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "instances.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Instances.SetLabels", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "instances_set_labels_request_resource", + "type": ".google.cloud.compute.v1.InstancesSetLabelsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Instances.SetLabels", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetMachineResources_async", + "title": "AcceleratorTypes setMachineResources Sample", + "origin": "API_DEFINITION", + "description": " Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.", + "canonical": true, + "file": "instances.set_machine_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetMachineResources", + "fullName": "google.cloud.compute.v1.Instances.SetMachineResources", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "instances_set_machine_resources_request_resource", + "type": ".google.cloud.compute.v1.InstancesSetMachineResourcesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetMachineResources", + "fullName": "google.cloud.compute.v1.Instances.SetMachineResources", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetMachineType_async", + "title": "AcceleratorTypes setMachineType Sample", + "origin": "API_DEFINITION", + "description": " Changes the machine type for a stopped instance to the machine type specified in the request.", + "canonical": true, + "file": "instances.set_machine_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetMachineType", + "fullName": "google.cloud.compute.v1.Instances.SetMachineType", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "instances_set_machine_type_request_resource", + "type": ".google.cloud.compute.v1.InstancesSetMachineTypeRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetMachineType", + "fullName": "google.cloud.compute.v1.Instances.SetMachineType", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetMetadata_async", + "title": "AcceleratorTypes setMetadata Sample", + "origin": "API_DEFINITION", + "description": " Sets metadata for the specified instance to the data included in the request.", + "canonical": true, + "file": "instances.set_metadata.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetMetadata", + "fullName": "google.cloud.compute.v1.Instances.SetMetadata", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "metadata_resource", + "type": ".google.cloud.compute.v1.Metadata" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetMetadata", + "fullName": "google.cloud.compute.v1.Instances.SetMetadata", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetMinCpuPlatform_async", + "title": "AcceleratorTypes setMinCpuPlatform Sample", + "origin": "API_DEFINITION", + "description": " Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.", + "canonical": true, + "file": "instances.set_min_cpu_platform.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetMinCpuPlatform", + "fullName": "google.cloud.compute.v1.Instances.SetMinCpuPlatform", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "instances_set_min_cpu_platform_request_resource", + "type": ".google.cloud.compute.v1.InstancesSetMinCpuPlatformRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetMinCpuPlatform", + "fullName": "google.cloud.compute.v1.Instances.SetMinCpuPlatform", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetName_async", + "title": "AcceleratorTypes setName Sample", + "origin": "API_DEFINITION", + "description": " Sets name of an instance.", + "canonical": true, + "file": "instances.set_name.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetName", + "fullName": "google.cloud.compute.v1.Instances.SetName", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "instances_set_name_request_resource", + "type": ".google.cloud.compute.v1.InstancesSetNameRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetName", + "fullName": "google.cloud.compute.v1.Instances.SetName", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetScheduling_async", + "title": "AcceleratorTypes setScheduling Sample", + "origin": "API_DEFINITION", + "description": " Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy.", + "canonical": true, + "file": "instances.set_scheduling.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetScheduling", + "fullName": "google.cloud.compute.v1.Instances.SetScheduling", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "scheduling_resource", + "type": ".google.cloud.compute.v1.Scheduling" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetScheduling", + "fullName": "google.cloud.compute.v1.Instances.SetScheduling", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetServiceAccount_async", + "title": "AcceleratorTypes setServiceAccount Sample", + "origin": "API_DEFINITION", + "description": " Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.", + "canonical": true, + "file": "instances.set_service_account.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetServiceAccount", + "fullName": "google.cloud.compute.v1.Instances.SetServiceAccount", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "instances_set_service_account_request_resource", + "type": ".google.cloud.compute.v1.InstancesSetServiceAccountRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetServiceAccount", + "fullName": "google.cloud.compute.v1.Instances.SetServiceAccount", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetShieldedInstanceIntegrityPolicy_async", + "title": "AcceleratorTypes setShieldedInstanceIntegrityPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "instances.set_shielded_instance_integrity_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetShieldedInstanceIntegrityPolicy", + "fullName": "google.cloud.compute.v1.Instances.SetShieldedInstanceIntegrityPolicy", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "shielded_instance_integrity_policy_resource", + "type": ".google.cloud.compute.v1.ShieldedInstanceIntegrityPolicy" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetShieldedInstanceIntegrityPolicy", + "fullName": "google.cloud.compute.v1.Instances.SetShieldedInstanceIntegrityPolicy", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SetTags_async", + "title": "AcceleratorTypes setTags Sample", + "origin": "API_DEFINITION", + "description": " Sets network tags for the specified instance to the data included in the request.", + "canonical": true, + "file": "instances.set_tags.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetTags", + "fullName": "google.cloud.compute.v1.Instances.SetTags", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "tags_resource", + "type": ".google.cloud.compute.v1.Tags" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SetTags", + "fullName": "google.cloud.compute.v1.Instances.SetTags", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_SimulateMaintenanceEvent_async", + "title": "AcceleratorTypes simulateMaintenanceEvent Sample", + "origin": "API_DEFINITION", + "description": " Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.", + "canonical": true, + "file": "instances.simulate_maintenance_event.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SimulateMaintenanceEvent", + "fullName": "google.cloud.compute.v1.Instances.SimulateMaintenanceEvent", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "SimulateMaintenanceEvent", + "fullName": "google.cloud.compute.v1.Instances.SimulateMaintenanceEvent", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_Start_async", + "title": "AcceleratorTypes start Sample", + "origin": "API_DEFINITION", + "description": " Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.", + "canonical": true, + "file": "instances.start.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Start", + "fullName": "google.cloud.compute.v1.Instances.Start", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "Start", + "fullName": "google.cloud.compute.v1.Instances.Start", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_StartWithEncryptionKey_async", + "title": "AcceleratorTypes startWithEncryptionKey Sample", + "origin": "API_DEFINITION", + "description": " Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.", + "canonical": true, + "file": "instances.start_with_encryption_key.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StartWithEncryptionKey", + "fullName": "google.cloud.compute.v1.Instances.StartWithEncryptionKey", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "instances_start_with_encryption_key_request_resource", + "type": ".google.cloud.compute.v1.InstancesStartWithEncryptionKeyRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "StartWithEncryptionKey", + "fullName": "google.cloud.compute.v1.Instances.StartWithEncryptionKey", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_Stop_async", + "title": "AcceleratorTypes stop Sample", + "origin": "API_DEFINITION", + "description": " Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.", + "canonical": true, + "file": "instances.stop.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Stop", + "fullName": "google.cloud.compute.v1.Instances.Stop", + "async": true, + "parameters": [ + { + "name": "discard_local_ssd", + "type": "TYPE_BOOL" + }, + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "Stop", + "fullName": "google.cloud.compute.v1.Instances.Stop", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_Suspend_async", + "title": "AcceleratorTypes suspend Sample", + "origin": "API_DEFINITION", + "description": " This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.", + "canonical": true, + "file": "instances.suspend.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Suspend", + "fullName": "google.cloud.compute.v1.Instances.Suspend", + "async": true, + "parameters": [ + { + "name": "discard_local_ssd", + "type": "TYPE_BOOL" + }, + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "Suspend", + "fullName": "google.cloud.compute.v1.Instances.Suspend", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "instances.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Instances.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Instances.TestIamPermissions", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.", + "canonical": true, + "file": "instances.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 46, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Instances.Update", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "instance_resource", + "type": ".google.cloud.compute.v1.Instance" + }, + { + "name": "minimal_action", + "type": "TYPE_STRING" + }, + { + "name": "most_disruptive_allowed_action", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Instances.Update", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_UpdateAccessConfig_async", + "title": "AcceleratorTypes updateAccessConfig Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "instances.update_access_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateAccessConfig", + "fullName": "google.cloud.compute.v1.Instances.UpdateAccessConfig", + "async": true, + "parameters": [ + { + "name": "access_config_resource", + "type": ".google.cloud.compute.v1.AccessConfig" + }, + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "network_interface", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "UpdateAccessConfig", + "fullName": "google.cloud.compute.v1.Instances.UpdateAccessConfig", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_UpdateDisplayDevice_async", + "title": "AcceleratorTypes updateDisplayDevice Sample", + "origin": "API_DEFINITION", + "description": " Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "instances.update_display_device.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDisplayDevice", + "fullName": "google.cloud.compute.v1.Instances.UpdateDisplayDevice", + "async": true, + "parameters": [ + { + "name": "display_device_resource", + "type": ".google.cloud.compute.v1.DisplayDevice" + }, + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "UpdateDisplayDevice", + "fullName": "google.cloud.compute.v1.Instances.UpdateDisplayDevice", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_UpdateNetworkInterface_async", + "title": "AcceleratorTypes updateNetworkInterface Sample", + "origin": "API_DEFINITION", + "description": " Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.", + "canonical": true, + "file": "instances.update_network_interface.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateNetworkInterface", + "fullName": "google.cloud.compute.v1.Instances.UpdateNetworkInterface", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "network_interface", + "type": "TYPE_STRING" + }, + { + "name": "network_interface_resource", + "type": ".google.cloud.compute.v1.NetworkInterface" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "UpdateNetworkInterface", + "fullName": "google.cloud.compute.v1.Instances.UpdateNetworkInterface", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Instances_UpdateShieldedInstanceConfig_async", + "title": "AcceleratorTypes updateShieldedInstanceConfig Sample", + "origin": "API_DEFINITION", + "description": " Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "instances.update_shielded_instance_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateShieldedInstanceConfig", + "fullName": "google.cloud.compute.v1.Instances.UpdateShieldedInstanceConfig", + "async": true, + "parameters": [ + { + "name": "instance", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "shielded_instance_config_resource", + "type": ".google.cloud.compute.v1.ShieldedInstanceConfig" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstancesClient", + "fullName": "google.cloud.compute.v1.InstancesClient" + }, + "method": { + "shortName": "UpdateShieldedInstanceConfig", + "fullName": "google.cloud.compute.v1.Instances.UpdateShieldedInstanceConfig", + "service": { + "shortName": "Instances", + "fullName": "google.cloud.compute.v1.Instances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceTemplates_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project.", + "canonical": true, + "file": "instance_templates.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.InstanceTemplates.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceTemplateAggregatedList", + "client": { + "shortName": "InstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.InstanceTemplatesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.InstanceTemplates.AggregatedList", + "service": { + "shortName": "InstanceTemplates", + "fullName": "google.cloud.compute.v1.InstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceTemplates_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.", + "canonical": true, + "file": "instance_templates.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.InstanceTemplates.Delete", + "async": true, + "parameters": [ + { + "name": "instance_template", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.InstanceTemplatesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.InstanceTemplates.Delete", + "service": { + "shortName": "InstanceTemplates", + "fullName": "google.cloud.compute.v1.InstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceTemplates_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified instance template.", + "canonical": true, + "file": "instance_templates.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InstanceTemplates.Get", + "async": true, + "parameters": [ + { + "name": "instance_template", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceTemplate", + "client": { + "shortName": "InstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.InstanceTemplatesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InstanceTemplates.Get", + "service": { + "shortName": "InstanceTemplates", + "fullName": "google.cloud.compute.v1.InstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceTemplates_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "instance_templates.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.InstanceTemplates.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "InstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.InstanceTemplatesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.InstanceTemplates.GetIamPolicy", + "service": { + "shortName": "InstanceTemplates", + "fullName": "google.cloud.compute.v1.InstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceTemplates_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.", + "canonical": true, + "file": "instance_templates.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.InstanceTemplates.Insert", + "async": true, + "parameters": [ + { + "name": "instance_template_resource", + "type": ".google.cloud.compute.v1.InstanceTemplate" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.InstanceTemplatesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.InstanceTemplates.Insert", + "service": { + "shortName": "InstanceTemplates", + "fullName": "google.cloud.compute.v1.InstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceTemplates_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of instance templates that are contained within the specified project.", + "canonical": true, + "file": "instance_templates.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InstanceTemplates.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceTemplateList", + "client": { + "shortName": "InstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.InstanceTemplatesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InstanceTemplates.List", + "service": { + "shortName": "InstanceTemplates", + "fullName": "google.cloud.compute.v1.InstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceTemplates_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "instance_templates.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.InstanceTemplates.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "global_set_policy_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetPolicyRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "InstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.InstanceTemplatesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.InstanceTemplates.SetIamPolicy", + "service": { + "shortName": "InstanceTemplates", + "fullName": "google.cloud.compute.v1.InstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InstanceTemplates_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "instance_templates.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.InstanceTemplates.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "InstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.InstanceTemplatesClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.InstanceTemplates.TestIamPermissions", + "service": { + "shortName": "InstanceTemplates", + "fullName": "google.cloud.compute.v1.InstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InterconnectAttachments_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of interconnect attachments.", + "canonical": true, + "file": "interconnect_attachments.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.InterconnectAttachmentAggregatedList", + "client": { + "shortName": "InterconnectAttachmentsClient", + "fullName": "google.cloud.compute.v1.InterconnectAttachmentsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.AggregatedList", + "service": { + "shortName": "InterconnectAttachments", + "fullName": "google.cloud.compute.v1.InterconnectAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InterconnectAttachments_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified interconnect attachment.", + "canonical": true, + "file": "interconnect_attachments.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.Delete", + "async": true, + "parameters": [ + { + "name": "interconnect_attachment", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InterconnectAttachmentsClient", + "fullName": "google.cloud.compute.v1.InterconnectAttachmentsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.Delete", + "service": { + "shortName": "InterconnectAttachments", + "fullName": "google.cloud.compute.v1.InterconnectAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InterconnectAttachments_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified interconnect attachment.", + "canonical": true, + "file": "interconnect_attachments.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.Get", + "async": true, + "parameters": [ + { + "name": "interconnect_attachment", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InterconnectAttachment", + "client": { + "shortName": "InterconnectAttachmentsClient", + "fullName": "google.cloud.compute.v1.InterconnectAttachmentsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.Get", + "service": { + "shortName": "InterconnectAttachments", + "fullName": "google.cloud.compute.v1.InterconnectAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InterconnectAttachments_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an InterconnectAttachment in the specified project using the data included in the request.", + "canonical": true, + "file": "interconnect_attachments.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.Insert", + "async": true, + "parameters": [ + { + "name": "interconnect_attachment_resource", + "type": ".google.cloud.compute.v1.InterconnectAttachment" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InterconnectAttachmentsClient", + "fullName": "google.cloud.compute.v1.InterconnectAttachmentsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.Insert", + "service": { + "shortName": "InterconnectAttachments", + "fullName": "google.cloud.compute.v1.InterconnectAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InterconnectAttachments_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of interconnect attachments contained within the specified region.", + "canonical": true, + "file": "interconnect_attachments.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.InterconnectAttachmentList", + "client": { + "shortName": "InterconnectAttachmentsClient", + "fullName": "google.cloud.compute.v1.InterconnectAttachmentsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.List", + "service": { + "shortName": "InterconnectAttachments", + "fullName": "google.cloud.compute.v1.InterconnectAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InterconnectAttachments_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "interconnect_attachments.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.Patch", + "async": true, + "parameters": [ + { + "name": "interconnect_attachment", + "type": "TYPE_STRING" + }, + { + "name": "interconnect_attachment_resource", + "type": ".google.cloud.compute.v1.InterconnectAttachment" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InterconnectAttachmentsClient", + "fullName": "google.cloud.compute.v1.InterconnectAttachmentsClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.Patch", + "service": { + "shortName": "InterconnectAttachments", + "fullName": "google.cloud.compute.v1.InterconnectAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InterconnectAttachments_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "interconnect_attachments.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.SetLabels", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_labels_request_resource", + "type": ".google.cloud.compute.v1.RegionSetLabelsRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InterconnectAttachmentsClient", + "fullName": "google.cloud.compute.v1.InterconnectAttachmentsClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.InterconnectAttachments.SetLabels", + "service": { + "shortName": "InterconnectAttachments", + "fullName": "google.cloud.compute.v1.InterconnectAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InterconnectLocations_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.", + "canonical": true, + "file": "interconnect_locations.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InterconnectLocations.Get", + "async": true, + "parameters": [ + { + "name": "interconnect_location", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InterconnectLocation", + "client": { + "shortName": "InterconnectLocationsClient", + "fullName": "google.cloud.compute.v1.InterconnectLocationsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InterconnectLocations.Get", + "service": { + "shortName": "InterconnectLocations", + "fullName": "google.cloud.compute.v1.InterconnectLocations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InterconnectLocations_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of interconnect locations available to the specified project.", + "canonical": true, + "file": "interconnect_locations.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InterconnectLocations.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.InterconnectLocationList", + "client": { + "shortName": "InterconnectLocationsClient", + "fullName": "google.cloud.compute.v1.InterconnectLocationsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InterconnectLocations.List", + "service": { + "shortName": "InterconnectLocations", + "fullName": "google.cloud.compute.v1.InterconnectLocations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InterconnectRemoteLocations_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list() request.", + "canonical": true, + "file": "interconnect_remote_locations.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InterconnectRemoteLocations.Get", + "async": true, + "parameters": [ + { + "name": "interconnect_remote_location", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InterconnectRemoteLocation", + "client": { + "shortName": "InterconnectRemoteLocationsClient", + "fullName": "google.cloud.compute.v1.InterconnectRemoteLocationsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.InterconnectRemoteLocations.Get", + "service": { + "shortName": "InterconnectRemoteLocations", + "fullName": "google.cloud.compute.v1.InterconnectRemoteLocations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_InterconnectRemoteLocations_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of interconnect remote locations available to the specified project.", + "canonical": true, + "file": "interconnect_remote_locations.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InterconnectRemoteLocations.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.InterconnectRemoteLocationList", + "client": { + "shortName": "InterconnectRemoteLocationsClient", + "fullName": "google.cloud.compute.v1.InterconnectRemoteLocationsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.InterconnectRemoteLocations.List", + "service": { + "shortName": "InterconnectRemoteLocations", + "fullName": "google.cloud.compute.v1.InterconnectRemoteLocations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Interconnects_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified Interconnect.", + "canonical": true, + "file": "interconnects.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Interconnects.Delete", + "async": true, + "parameters": [ + { + "name": "interconnect", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InterconnectsClient", + "fullName": "google.cloud.compute.v1.InterconnectsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Interconnects.Delete", + "service": { + "shortName": "Interconnects", + "fullName": "google.cloud.compute.v1.Interconnects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Interconnects_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.", + "canonical": true, + "file": "interconnects.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Interconnects.Get", + "async": true, + "parameters": [ + { + "name": "interconnect", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Interconnect", + "client": { + "shortName": "InterconnectsClient", + "fullName": "google.cloud.compute.v1.InterconnectsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Interconnects.Get", + "service": { + "shortName": "Interconnects", + "fullName": "google.cloud.compute.v1.Interconnects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Interconnects_GetDiagnostics_async", + "title": "AcceleratorTypes getDiagnostics Sample", + "origin": "API_DEFINITION", + "description": " Returns the interconnectDiagnostics for the specified Interconnect.", + "canonical": true, + "file": "interconnects.get_diagnostics.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDiagnostics", + "fullName": "google.cloud.compute.v1.Interconnects.GetDiagnostics", + "async": true, + "parameters": [ + { + "name": "interconnect", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InterconnectsGetDiagnosticsResponse", + "client": { + "shortName": "InterconnectsClient", + "fullName": "google.cloud.compute.v1.InterconnectsClient" + }, + "method": { + "shortName": "GetDiagnostics", + "fullName": "google.cloud.compute.v1.Interconnects.GetDiagnostics", + "service": { + "shortName": "Interconnects", + "fullName": "google.cloud.compute.v1.Interconnects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Interconnects_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an Interconnect in the specified project using the data included in the request.", + "canonical": true, + "file": "interconnects.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Interconnects.Insert", + "async": true, + "parameters": [ + { + "name": "interconnect_resource", + "type": ".google.cloud.compute.v1.Interconnect" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InterconnectsClient", + "fullName": "google.cloud.compute.v1.InterconnectsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Interconnects.Insert", + "service": { + "shortName": "Interconnects", + "fullName": "google.cloud.compute.v1.Interconnects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Interconnects_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of Interconnects available to the specified project.", + "canonical": true, + "file": "interconnects.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Interconnects.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.InterconnectList", + "client": { + "shortName": "InterconnectsClient", + "fullName": "google.cloud.compute.v1.InterconnectsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Interconnects.List", + "service": { + "shortName": "Interconnects", + "fullName": "google.cloud.compute.v1.Interconnects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Interconnects_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "interconnects.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Interconnects.Patch", + "async": true, + "parameters": [ + { + "name": "interconnect", + "type": "TYPE_STRING" + }, + { + "name": "interconnect_resource", + "type": ".google.cloud.compute.v1.Interconnect" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InterconnectsClient", + "fullName": "google.cloud.compute.v1.InterconnectsClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Interconnects.Patch", + "service": { + "shortName": "Interconnects", + "fullName": "google.cloud.compute.v1.Interconnects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Interconnects_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "interconnects.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Interconnects.SetLabels", + "async": true, + "parameters": [ + { + "name": "global_set_labels_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetLabelsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "InterconnectsClient", + "fullName": "google.cloud.compute.v1.InterconnectsClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Interconnects.SetLabels", + "service": { + "shortName": "Interconnects", + "fullName": "google.cloud.compute.v1.Interconnects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_LicenseCodes_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", + "canonical": true, + "file": "license_codes.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.LicenseCodes.Get", + "async": true, + "parameters": [ + { + "name": "license_code", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.LicenseCode", + "client": { + "shortName": "LicenseCodesClient", + "fullName": "google.cloud.compute.v1.LicenseCodesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.LicenseCodes.Get", + "service": { + "shortName": "LicenseCodes", + "fullName": "google.cloud.compute.v1.LicenseCodes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_LicenseCodes_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", + "canonical": true, + "file": "license_codes.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.LicenseCodes.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "LicenseCodesClient", + "fullName": "google.cloud.compute.v1.LicenseCodesClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.LicenseCodes.TestIamPermissions", + "service": { + "shortName": "LicenseCodes", + "fullName": "google.cloud.compute.v1.LicenseCodes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Licenses_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", + "canonical": true, + "file": "licenses.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Licenses.Delete", + "async": true, + "parameters": [ + { + "name": "license", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "LicensesClient", + "fullName": "google.cloud.compute.v1.LicensesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Licenses.Delete", + "service": { + "shortName": "Licenses", + "fullName": "google.cloud.compute.v1.Licenses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Licenses_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", + "canonical": true, + "file": "licenses.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Licenses.Get", + "async": true, + "parameters": [ + { + "name": "license", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.License", + "client": { + "shortName": "LicensesClient", + "fullName": "google.cloud.compute.v1.LicensesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Licenses.Get", + "service": { + "shortName": "Licenses", + "fullName": "google.cloud.compute.v1.Licenses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Licenses_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", + "canonical": true, + "file": "licenses.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Licenses.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "LicensesClient", + "fullName": "google.cloud.compute.v1.LicensesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Licenses.GetIamPolicy", + "service": { + "shortName": "Licenses", + "fullName": "google.cloud.compute.v1.Licenses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Licenses_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", + "canonical": true, + "file": "licenses.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Licenses.Insert", + "async": true, + "parameters": [ + { + "name": "license_resource", + "type": ".google.cloud.compute.v1.License" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "LicensesClient", + "fullName": "google.cloud.compute.v1.LicensesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Licenses.Insert", + "service": { + "shortName": "Licenses", + "fullName": "google.cloud.compute.v1.Licenses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Licenses_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", + "canonical": true, + "file": "licenses.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Licenses.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.LicensesListResponse", + "client": { + "shortName": "LicensesClient", + "fullName": "google.cloud.compute.v1.LicensesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Licenses.List", + "service": { + "shortName": "Licenses", + "fullName": "google.cloud.compute.v1.Licenses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Licenses_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", + "canonical": true, + "file": "licenses.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Licenses.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "global_set_policy_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetPolicyRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "LicensesClient", + "fullName": "google.cloud.compute.v1.LicensesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Licenses.SetIamPolicy", + "service": { + "shortName": "Licenses", + "fullName": "google.cloud.compute.v1.Licenses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Licenses_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", + "canonical": true, + "file": "licenses.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Licenses.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "LicensesClient", + "fullName": "google.cloud.compute.v1.LicensesClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Licenses.TestIamPermissions", + "service": { + "shortName": "Licenses", + "fullName": "google.cloud.compute.v1.Licenses" + } + } + } + }, + { + "regionTag": "compute_v1_generated_MachineImages_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.", + "canonical": true, + "file": "machine_images.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.MachineImages.Delete", + "async": true, + "parameters": [ + { + "name": "machine_image", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "MachineImagesClient", + "fullName": "google.cloud.compute.v1.MachineImagesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.MachineImages.Delete", + "service": { + "shortName": "MachineImages", + "fullName": "google.cloud.compute.v1.MachineImages" + } + } + } + }, + { + "regionTag": "compute_v1_generated_MachineImages_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified machine image.", + "canonical": true, + "file": "machine_images.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.MachineImages.Get", + "async": true, + "parameters": [ + { + "name": "machine_image", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.MachineImage", + "client": { + "shortName": "MachineImagesClient", + "fullName": "google.cloud.compute.v1.MachineImagesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.MachineImages.Get", + "service": { + "shortName": "MachineImages", + "fullName": "google.cloud.compute.v1.MachineImages" + } + } + } + }, + { + "regionTag": "compute_v1_generated_MachineImages_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "machine_images.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.MachineImages.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "MachineImagesClient", + "fullName": "google.cloud.compute.v1.MachineImagesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.MachineImages.GetIamPolicy", + "service": { + "shortName": "MachineImages", + "fullName": "google.cloud.compute.v1.MachineImages" + } + } + } + }, + { + "regionTag": "compute_v1_generated_MachineImages_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance.", + "canonical": true, + "file": "machine_images.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.MachineImages.Insert", + "async": true, + "parameters": [ + { + "name": "machine_image_resource", + "type": ".google.cloud.compute.v1.MachineImage" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "source_instance", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "MachineImagesClient", + "fullName": "google.cloud.compute.v1.MachineImagesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.MachineImages.Insert", + "service": { + "shortName": "MachineImages", + "fullName": "google.cloud.compute.v1.MachineImages" + } + } + } + }, + { + "regionTag": "compute_v1_generated_MachineImages_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of machine images that are contained within the specified project.", + "canonical": true, + "file": "machine_images.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.MachineImages.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.MachineImageList", + "client": { + "shortName": "MachineImagesClient", + "fullName": "google.cloud.compute.v1.MachineImagesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.MachineImages.List", + "service": { + "shortName": "MachineImages", + "fullName": "google.cloud.compute.v1.MachineImages" + } + } + } + }, + { + "regionTag": "compute_v1_generated_MachineImages_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "machine_images.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.MachineImages.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "global_set_policy_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetPolicyRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "MachineImagesClient", + "fullName": "google.cloud.compute.v1.MachineImagesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.MachineImages.SetIamPolicy", + "service": { + "shortName": "MachineImages", + "fullName": "google.cloud.compute.v1.MachineImages" + } + } + } + }, + { + "regionTag": "compute_v1_generated_MachineImages_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "machine_images.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.MachineImages.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "MachineImagesClient", + "fullName": "google.cloud.compute.v1.MachineImagesClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.MachineImages.TestIamPermissions", + "service": { + "shortName": "MachineImages", + "fullName": "google.cloud.compute.v1.MachineImages" + } + } + } + }, + { + "regionTag": "compute_v1_generated_MachineTypes_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of machine types.", + "canonical": true, + "file": "machine_types.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.MachineTypes.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.MachineTypeAggregatedList", + "client": { + "shortName": "MachineTypesClient", + "fullName": "google.cloud.compute.v1.MachineTypesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.MachineTypes.AggregatedList", + "service": { + "shortName": "MachineTypes", + "fullName": "google.cloud.compute.v1.MachineTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_MachineTypes_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified machine type.", + "canonical": true, + "file": "machine_types.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.MachineTypes.Get", + "async": true, + "parameters": [ + { + "name": "machine_type", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.MachineType", + "client": { + "shortName": "MachineTypesClient", + "fullName": "google.cloud.compute.v1.MachineTypesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.MachineTypes.Get", + "service": { + "shortName": "MachineTypes", + "fullName": "google.cloud.compute.v1.MachineTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_MachineTypes_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of machine types available to the specified project.", + "canonical": true, + "file": "machine_types.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.MachineTypes.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.MachineTypeList", + "client": { + "shortName": "MachineTypesClient", + "fullName": "google.cloud.compute.v1.MachineTypesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.MachineTypes.List", + "service": { + "shortName": "MachineTypes", + "fullName": "google.cloud.compute.v1.MachineTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkAttachments_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.", + "canonical": true, + "file": "network_attachments.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NetworkAttachments.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkAttachmentAggregatedList", + "client": { + "shortName": "NetworkAttachmentsClient", + "fullName": "google.cloud.compute.v1.NetworkAttachmentsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NetworkAttachments.AggregatedList", + "service": { + "shortName": "NetworkAttachments", + "fullName": "google.cloud.compute.v1.NetworkAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkAttachments_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified NetworkAttachment in the given scope", + "canonical": true, + "file": "network_attachments.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NetworkAttachments.Delete", + "async": true, + "parameters": [ + { + "name": "network_attachment", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkAttachmentsClient", + "fullName": "google.cloud.compute.v1.NetworkAttachmentsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NetworkAttachments.Delete", + "service": { + "shortName": "NetworkAttachments", + "fullName": "google.cloud.compute.v1.NetworkAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkAttachments_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified NetworkAttachment resource in the given scope.", + "canonical": true, + "file": "network_attachments.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NetworkAttachments.Get", + "async": true, + "parameters": [ + { + "name": "network_attachment", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkAttachment", + "client": { + "shortName": "NetworkAttachmentsClient", + "fullName": "google.cloud.compute.v1.NetworkAttachmentsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NetworkAttachments.Get", + "service": { + "shortName": "NetworkAttachments", + "fullName": "google.cloud.compute.v1.NetworkAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkAttachments_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "network_attachments.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.NetworkAttachments.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "NetworkAttachmentsClient", + "fullName": "google.cloud.compute.v1.NetworkAttachmentsClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.NetworkAttachments.GetIamPolicy", + "service": { + "shortName": "NetworkAttachments", + "fullName": "google.cloud.compute.v1.NetworkAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkAttachments_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.", + "canonical": true, + "file": "network_attachments.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NetworkAttachments.Insert", + "async": true, + "parameters": [ + { + "name": "network_attachment_resource", + "type": ".google.cloud.compute.v1.NetworkAttachment" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkAttachmentsClient", + "fullName": "google.cloud.compute.v1.NetworkAttachmentsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NetworkAttachments.Insert", + "service": { + "shortName": "NetworkAttachments", + "fullName": "google.cloud.compute.v1.NetworkAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkAttachments_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists the NetworkAttachments for a project in the given scope.", + "canonical": true, + "file": "network_attachments.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NetworkAttachments.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkAttachmentList", + "client": { + "shortName": "NetworkAttachmentsClient", + "fullName": "google.cloud.compute.v1.NetworkAttachmentsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NetworkAttachments.List", + "service": { + "shortName": "NetworkAttachments", + "fullName": "google.cloud.compute.v1.NetworkAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkAttachments_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "network_attachments.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.NetworkAttachments.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_policy_request_resource", + "type": ".google.cloud.compute.v1.RegionSetPolicyRequest" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "NetworkAttachmentsClient", + "fullName": "google.cloud.compute.v1.NetworkAttachmentsClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.NetworkAttachments.SetIamPolicy", + "service": { + "shortName": "NetworkAttachments", + "fullName": "google.cloud.compute.v1.NetworkAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkAttachments_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "network_attachments.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.NetworkAttachments.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "NetworkAttachmentsClient", + "fullName": "google.cloud.compute.v1.NetworkAttachmentsClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.NetworkAttachments.TestIamPermissions", + "service": { + "shortName": "NetworkAttachments", + "fullName": "google.cloud.compute.v1.NetworkAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEdgeSecurityServices_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project.", + "canonical": true, + "file": "network_edge_security_services.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkEdgeSecurityServiceAggregatedList", + "client": { + "shortName": "NetworkEdgeSecurityServicesClient", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServicesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices.AggregatedList", + "service": { + "shortName": "NetworkEdgeSecurityServices", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEdgeSecurityServices_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified service.", + "canonical": true, + "file": "network_edge_security_services.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices.Delete", + "async": true, + "parameters": [ + { + "name": "network_edge_security_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkEdgeSecurityServicesClient", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServicesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices.Delete", + "service": { + "shortName": "NetworkEdgeSecurityServices", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEdgeSecurityServices_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Gets a specified NetworkEdgeSecurityService.", + "canonical": true, + "file": "network_edge_security_services.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices.Get", + "async": true, + "parameters": [ + { + "name": "network_edge_security_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkEdgeSecurityService", + "client": { + "shortName": "NetworkEdgeSecurityServicesClient", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServicesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices.Get", + "service": { + "shortName": "NetworkEdgeSecurityServices", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEdgeSecurityServices_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a new service in the specified project using the data included in the request.", + "canonical": true, + "file": "network_edge_security_services.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices.Insert", + "async": true, + "parameters": [ + { + "name": "network_edge_security_service_resource", + "type": ".google.cloud.compute.v1.NetworkEdgeSecurityService" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkEdgeSecurityServicesClient", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServicesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices.Insert", + "service": { + "shortName": "NetworkEdgeSecurityServices", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEdgeSecurityServices_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified policy with the data included in the request.", + "canonical": true, + "file": "network_edge_security_services.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices.Patch", + "async": true, + "parameters": [ + { + "name": "network_edge_security_service", + "type": "TYPE_STRING" + }, + { + "name": "network_edge_security_service_resource", + "type": ".google.cloud.compute.v1.NetworkEdgeSecurityService" + }, + { + "name": "paths", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "update_mask", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkEdgeSecurityServicesClient", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServicesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices.Patch", + "service": { + "shortName": "NetworkEdgeSecurityServices", + "fullName": "google.cloud.compute.v1.NetworkEdgeSecurityServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEndpointGroups_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of network endpoint groups and sorts them by zone.", + "canonical": true, + "file": "network_endpoint_groups.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkEndpointGroupAggregatedList", + "client": { + "shortName": "NetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroupsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.AggregatedList", + "service": { + "shortName": "NetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEndpointGroups_AttachNetworkEndpoints_async", + "title": "AcceleratorTypes attachNetworkEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Attach a list of network endpoints to the specified network endpoint group.", + "canonical": true, + "file": "network_endpoint_groups.attach_network_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AttachNetworkEndpoints", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.AttachNetworkEndpoints", + "async": true, + "parameters": [ + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "network_endpoint_groups_attach_endpoints_request_resource", + "type": ".google.cloud.compute.v1.NetworkEndpointGroupsAttachEndpointsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroupsClient" + }, + "method": { + "shortName": "AttachNetworkEndpoints", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.AttachNetworkEndpoints", + "service": { + "shortName": "NetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEndpointGroups_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.", + "canonical": true, + "file": "network_endpoint_groups.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.Delete", + "async": true, + "parameters": [ + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroupsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.Delete", + "service": { + "shortName": "NetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEndpointGroups_DetachNetworkEndpoints_async", + "title": "AcceleratorTypes detachNetworkEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Detach a list of network endpoints from the specified network endpoint group.", + "canonical": true, + "file": "network_endpoint_groups.detach_network_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DetachNetworkEndpoints", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.DetachNetworkEndpoints", + "async": true, + "parameters": [ + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "network_endpoint_groups_detach_endpoints_request_resource", + "type": ".google.cloud.compute.v1.NetworkEndpointGroupsDetachEndpointsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroupsClient" + }, + "method": { + "shortName": "DetachNetworkEndpoints", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.DetachNetworkEndpoints", + "service": { + "shortName": "NetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEndpointGroups_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified network endpoint group.", + "canonical": true, + "file": "network_endpoint_groups.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.Get", + "async": true, + "parameters": [ + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkEndpointGroup", + "client": { + "shortName": "NetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroupsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.Get", + "service": { + "shortName": "NetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEndpointGroups_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a network endpoint group in the specified project using the parameters that are included in the request.", + "canonical": true, + "file": "network_endpoint_groups.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.Insert", + "async": true, + "parameters": [ + { + "name": "network_endpoint_group_resource", + "type": ".google.cloud.compute.v1.NetworkEndpointGroup" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroupsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.Insert", + "service": { + "shortName": "NetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEndpointGroups_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of network endpoint groups that are located in the specified project and zone.", + "canonical": true, + "file": "network_endpoint_groups.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkEndpointGroupList", + "client": { + "shortName": "NetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroupsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.List", + "service": { + "shortName": "NetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEndpointGroups_ListNetworkEndpoints_async", + "title": "AcceleratorTypes listNetworkEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Lists the network endpoints in the specified network endpoint group.", + "canonical": true, + "file": "network_endpoint_groups.list_network_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNetworkEndpoints", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.ListNetworkEndpoints", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "network_endpoint_groups_list_endpoints_request_resource", + "type": ".google.cloud.compute.v1.NetworkEndpointGroupsListEndpointsRequest" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkEndpointGroupsListNetworkEndpoints", + "client": { + "shortName": "NetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroupsClient" + }, + "method": { + "shortName": "ListNetworkEndpoints", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.ListNetworkEndpoints", + "service": { + "shortName": "NetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkEndpointGroups_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "network_endpoint_groups.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "NetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroupsClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups.TestIamPermissions", + "service": { + "shortName": "NetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.NetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_AddAssociation_async", + "title": "AcceleratorTypes addAssociation Sample", + "origin": "API_DEFINITION", + "description": " Inserts an association for the specified firewall policy.", + "canonical": true, + "file": "network_firewall_policies.add_association.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddAssociation", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.AddAssociation", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_association_resource", + "type": ".google.cloud.compute.v1.FirewallPolicyAssociation" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "replace_existing_association", + "type": "TYPE_BOOL" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "AddAssociation", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.AddAssociation", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_AddRule_async", + "title": "AcceleratorTypes addRule Sample", + "origin": "API_DEFINITION", + "description": " Inserts a rule into a firewall policy.", + "canonical": true, + "file": "network_firewall_policies.add_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddRule", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.AddRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_rule_resource", + "type": ".google.cloud.compute.v1.FirewallPolicyRule" + }, + { + "name": "max_priority", + "type": "TYPE_INT32" + }, + { + "name": "min_priority", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "AddRule", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.AddRule", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_CloneRules_async", + "title": "AcceleratorTypes cloneRules Sample", + "origin": "API_DEFINITION", + "description": " Copies rules to the specified firewall policy.", + "canonical": true, + "file": "network_firewall_policies.clone_rules.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CloneRules", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.CloneRules", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "source_firewall_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "CloneRules", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.CloneRules", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified policy.", + "canonical": true, + "file": "network_firewall_policies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.Delete", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.Delete", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified network firewall policy.", + "canonical": true, + "file": "network_firewall_policies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.Get", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicy", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.Get", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_GetAssociation_async", + "title": "AcceleratorTypes getAssociation Sample", + "origin": "API_DEFINITION", + "description": " Gets an association with the specified name.", + "canonical": true, + "file": "network_firewall_policies.get_association.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAssociation", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.GetAssociation", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicyAssociation", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "GetAssociation", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.GetAssociation", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "network_firewall_policies.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.GetIamPolicy", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_GetRule_async", + "title": "AcceleratorTypes getRule Sample", + "origin": "API_DEFINITION", + "description": " Gets a rule of the specified priority.", + "canonical": true, + "file": "network_firewall_policies.get_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetRule", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.GetRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "priority", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicyRule", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "GetRule", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.GetRule", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a new policy in the specified project using the data included in the request.", + "canonical": true, + "file": "network_firewall_policies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.Insert", + "async": true, + "parameters": [ + { + "name": "firewall_policy_resource", + "type": ".google.cloud.compute.v1.FirewallPolicy" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.Insert", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists all the policies that have been configured for the specified project.", + "canonical": true, + "file": "network_firewall_policies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicyList", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.List", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified policy with the data included in the request.", + "canonical": true, + "file": "network_firewall_policies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.Patch", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_resource", + "type": ".google.cloud.compute.v1.FirewallPolicy" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.Patch", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_PatchRule_async", + "title": "AcceleratorTypes patchRule Sample", + "origin": "API_DEFINITION", + "description": " Patches a rule of the specified priority.", + "canonical": true, + "file": "network_firewall_policies.patch_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PatchRule", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.PatchRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_rule_resource", + "type": ".google.cloud.compute.v1.FirewallPolicyRule" + }, + { + "name": "priority", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "PatchRule", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.PatchRule", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_RemoveAssociation_async", + "title": "AcceleratorTypes removeAssociation Sample", + "origin": "API_DEFINITION", + "description": " Removes an association for the specified firewall policy.", + "canonical": true, + "file": "network_firewall_policies.remove_association.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveAssociation", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.RemoveAssociation", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "RemoveAssociation", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.RemoveAssociation", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_RemoveRule_async", + "title": "AcceleratorTypes removeRule Sample", + "origin": "API_DEFINITION", + "description": " Deletes a rule of the specified priority.", + "canonical": true, + "file": "network_firewall_policies.remove_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveRule", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.RemoveRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "priority", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "RemoveRule", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.RemoveRule", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "network_firewall_policies.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "global_set_policy_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetPolicyRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.SetIamPolicy", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NetworkFirewallPolicies_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "network_firewall_policies.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "NetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.NetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies.TestIamPermissions", + "service": { + "shortName": "NetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.NetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Networks_AddPeering_async", + "title": "AcceleratorTypes addPeering Sample", + "origin": "API_DEFINITION", + "description": " Adds a peering to the specified network.", + "canonical": true, + "file": "networks.add_peering.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddPeering", + "fullName": "google.cloud.compute.v1.Networks.AddPeering", + "async": true, + "parameters": [ + { + "name": "network", + "type": "TYPE_STRING" + }, + { + "name": "networks_add_peering_request_resource", + "type": ".google.cloud.compute.v1.NetworksAddPeeringRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworksClient", + "fullName": "google.cloud.compute.v1.NetworksClient" + }, + "method": { + "shortName": "AddPeering", + "fullName": "google.cloud.compute.v1.Networks.AddPeering", + "service": { + "shortName": "Networks", + "fullName": "google.cloud.compute.v1.Networks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Networks_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified network.", + "canonical": true, + "file": "networks.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Networks.Delete", + "async": true, + "parameters": [ + { + "name": "network", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworksClient", + "fullName": "google.cloud.compute.v1.NetworksClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Networks.Delete", + "service": { + "shortName": "Networks", + "fullName": "google.cloud.compute.v1.Networks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Networks_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified network.", + "canonical": true, + "file": "networks.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Networks.Get", + "async": true, + "parameters": [ + { + "name": "network", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Network", + "client": { + "shortName": "NetworksClient", + "fullName": "google.cloud.compute.v1.NetworksClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Networks.Get", + "service": { + "shortName": "Networks", + "fullName": "google.cloud.compute.v1.Networks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Networks_GetEffectiveFirewalls_async", + "title": "AcceleratorTypes getEffectiveFirewalls Sample", + "origin": "API_DEFINITION", + "description": " Returns the effective firewalls on a given network.", + "canonical": true, + "file": "networks.get_effective_firewalls.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEffectiveFirewalls", + "fullName": "google.cloud.compute.v1.Networks.GetEffectiveFirewalls", + "async": true, + "parameters": [ + { + "name": "network", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NetworksGetEffectiveFirewallsResponse", + "client": { + "shortName": "NetworksClient", + "fullName": "google.cloud.compute.v1.NetworksClient" + }, + "method": { + "shortName": "GetEffectiveFirewalls", + "fullName": "google.cloud.compute.v1.Networks.GetEffectiveFirewalls", + "service": { + "shortName": "Networks", + "fullName": "google.cloud.compute.v1.Networks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Networks_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a network in the specified project using the data included in the request.", + "canonical": true, + "file": "networks.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Networks.Insert", + "async": true, + "parameters": [ + { + "name": "network_resource", + "type": ".google.cloud.compute.v1.Network" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworksClient", + "fullName": "google.cloud.compute.v1.NetworksClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Networks.Insert", + "service": { + "shortName": "Networks", + "fullName": "google.cloud.compute.v1.Networks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Networks_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of networks available to the specified project.", + "canonical": true, + "file": "networks.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Networks.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkList", + "client": { + "shortName": "NetworksClient", + "fullName": "google.cloud.compute.v1.NetworksClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Networks.List", + "service": { + "shortName": "Networks", + "fullName": "google.cloud.compute.v1.Networks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Networks_ListPeeringRoutes_async", + "title": "AcceleratorTypes listPeeringRoutes Sample", + "origin": "API_DEFINITION", + "description": " Lists the peering routes exchanged over peering connection.", + "canonical": true, + "file": "networks.list_peering_routes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 93, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPeeringRoutes", + "fullName": "google.cloud.compute.v1.Networks.ListPeeringRoutes", + "async": true, + "parameters": [ + { + "name": "direction", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "network", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "peering_name", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ExchangedPeeringRoutesList", + "client": { + "shortName": "NetworksClient", + "fullName": "google.cloud.compute.v1.NetworksClient" + }, + "method": { + "shortName": "ListPeeringRoutes", + "fullName": "google.cloud.compute.v1.Networks.ListPeeringRoutes", + "service": { + "shortName": "Networks", + "fullName": "google.cloud.compute.v1.Networks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Networks_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.", + "canonical": true, + "file": "networks.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Networks.Patch", + "async": true, + "parameters": [ + { + "name": "network", + "type": "TYPE_STRING" + }, + { + "name": "network_resource", + "type": ".google.cloud.compute.v1.Network" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworksClient", + "fullName": "google.cloud.compute.v1.NetworksClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Networks.Patch", + "service": { + "shortName": "Networks", + "fullName": "google.cloud.compute.v1.Networks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Networks_RemovePeering_async", + "title": "AcceleratorTypes removePeering Sample", + "origin": "API_DEFINITION", + "description": " Removes a peering from the specified network.", + "canonical": true, + "file": "networks.remove_peering.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemovePeering", + "fullName": "google.cloud.compute.v1.Networks.RemovePeering", + "async": true, + "parameters": [ + { + "name": "network", + "type": "TYPE_STRING" + }, + { + "name": "networks_remove_peering_request_resource", + "type": ".google.cloud.compute.v1.NetworksRemovePeeringRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworksClient", + "fullName": "google.cloud.compute.v1.NetworksClient" + }, + "method": { + "shortName": "RemovePeering", + "fullName": "google.cloud.compute.v1.Networks.RemovePeering", + "service": { + "shortName": "Networks", + "fullName": "google.cloud.compute.v1.Networks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Networks_SwitchToCustomMode_async", + "title": "AcceleratorTypes switchToCustomMode Sample", + "origin": "API_DEFINITION", + "description": " Switches the network mode from auto subnet mode to custom subnet mode.", + "canonical": true, + "file": "networks.switch_to_custom_mode.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SwitchToCustomMode", + "fullName": "google.cloud.compute.v1.Networks.SwitchToCustomMode", + "async": true, + "parameters": [ + { + "name": "network", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworksClient", + "fullName": "google.cloud.compute.v1.NetworksClient" + }, + "method": { + "shortName": "SwitchToCustomMode", + "fullName": "google.cloud.compute.v1.Networks.SwitchToCustomMode", + "service": { + "shortName": "Networks", + "fullName": "google.cloud.compute.v1.Networks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Networks_UpdatePeering_async", + "title": "AcceleratorTypes updatePeering Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field.", + "canonical": true, + "file": "networks.update_peering.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdatePeering", + "fullName": "google.cloud.compute.v1.Networks.UpdatePeering", + "async": true, + "parameters": [ + { + "name": "network", + "type": "TYPE_STRING" + }, + { + "name": "networks_update_peering_request_resource", + "type": ".google.cloud.compute.v1.NetworksUpdatePeeringRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NetworksClient", + "fullName": "google.cloud.compute.v1.NetworksClient" + }, + "method": { + "shortName": "UpdatePeering", + "fullName": "google.cloud.compute.v1.Networks.UpdatePeering", + "service": { + "shortName": "Networks", + "fullName": "google.cloud.compute.v1.Networks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_AddNodes_async", + "title": "AcceleratorTypes addNodes Sample", + "origin": "API_DEFINITION", + "description": " Adds specified number of nodes to the node group.", + "canonical": true, + "file": "node_groups.add_nodes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddNodes", + "fullName": "google.cloud.compute.v1.NodeGroups.AddNodes", + "async": true, + "parameters": [ + { + "name": "node_group", + "type": "TYPE_STRING" + }, + { + "name": "node_groups_add_nodes_request_resource", + "type": ".google.cloud.compute.v1.NodeGroupsAddNodesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "AddNodes", + "fullName": "google.cloud.compute.v1.NodeGroups.AddNodes", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.", + "canonical": true, + "file": "node_groups.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NodeGroups.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NodeGroupAggregatedList", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NodeGroups.AggregatedList", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified NodeGroup resource.", + "canonical": true, + "file": "node_groups.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NodeGroups.Delete", + "async": true, + "parameters": [ + { + "name": "node_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NodeGroups.Delete", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_DeleteNodes_async", + "title": "AcceleratorTypes deleteNodes Sample", + "origin": "API_DEFINITION", + "description": " Deletes specified nodes from the node group.", + "canonical": true, + "file": "node_groups.delete_nodes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteNodes", + "fullName": "google.cloud.compute.v1.NodeGroups.DeleteNodes", + "async": true, + "parameters": [ + { + "name": "node_group", + "type": "TYPE_STRING" + }, + { + "name": "node_groups_delete_nodes_request_resource", + "type": ".google.cloud.compute.v1.NodeGroupsDeleteNodesRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "DeleteNodes", + "fullName": "google.cloud.compute.v1.NodeGroups.DeleteNodes", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the \"nodes\" field should not be used. Use nodeGroups.listNodes instead.", + "canonical": true, + "file": "node_groups.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NodeGroups.Get", + "async": true, + "parameters": [ + { + "name": "node_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NodeGroup", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NodeGroups.Get", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "node_groups.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.NodeGroups.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.NodeGroups.GetIamPolicy", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a NodeGroup resource in the specified project using the data included in the request.", + "canonical": true, + "file": "node_groups.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NodeGroups.Insert", + "async": true, + "parameters": [ + { + "name": "initial_node_count", + "type": "TYPE_INT32" + }, + { + "name": "node_group_resource", + "type": ".google.cloud.compute.v1.NodeGroup" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NodeGroups.Insert", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.", + "canonical": true, + "file": "node_groups.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NodeGroups.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NodeGroupList", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NodeGroups.List", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_ListNodes_async", + "title": "AcceleratorTypes listNodes Sample", + "origin": "API_DEFINITION", + "description": " Lists nodes in the node group.", + "canonical": true, + "file": "node_groups.list_nodes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNodes", + "fullName": "google.cloud.compute.v1.NodeGroups.ListNodes", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "node_group", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NodeGroupsListNodes", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "ListNodes", + "fullName": "google.cloud.compute.v1.NodeGroups.ListNodes", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified node group.", + "canonical": true, + "file": "node_groups.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.NodeGroups.Patch", + "async": true, + "parameters": [ + { + "name": "node_group", + "type": "TYPE_STRING" + }, + { + "name": "node_group_resource", + "type": ".google.cloud.compute.v1.NodeGroup" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.NodeGroups.Patch", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "node_groups.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.NodeGroups.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + }, + { + "name": "zone_set_policy_request_resource", + "type": ".google.cloud.compute.v1.ZoneSetPolicyRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.NodeGroups.SetIamPolicy", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_SetNodeTemplate_async", + "title": "AcceleratorTypes setNodeTemplate Sample", + "origin": "API_DEFINITION", + "description": " Updates the node template of the node group.", + "canonical": true, + "file": "node_groups.set_node_template.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetNodeTemplate", + "fullName": "google.cloud.compute.v1.NodeGroups.SetNodeTemplate", + "async": true, + "parameters": [ + { + "name": "node_group", + "type": "TYPE_STRING" + }, + { + "name": "node_groups_set_node_template_request_resource", + "type": ".google.cloud.compute.v1.NodeGroupsSetNodeTemplateRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "SetNodeTemplate", + "fullName": "google.cloud.compute.v1.NodeGroups.SetNodeTemplate", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_SimulateMaintenanceEvent_async", + "title": "AcceleratorTypes simulateMaintenanceEvent Sample", + "origin": "API_DEFINITION", + "description": " Simulates maintenance event on specified nodes from the node group.", + "canonical": true, + "file": "node_groups.simulate_maintenance_event.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SimulateMaintenanceEvent", + "fullName": "google.cloud.compute.v1.NodeGroups.SimulateMaintenanceEvent", + "async": true, + "parameters": [ + { + "name": "node_group", + "type": "TYPE_STRING" + }, + { + "name": "node_groups_simulate_maintenance_event_request_resource", + "type": ".google.cloud.compute.v1.NodeGroupsSimulateMaintenanceEventRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "SimulateMaintenanceEvent", + "fullName": "google.cloud.compute.v1.NodeGroups.SimulateMaintenanceEvent", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeGroups_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "node_groups.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.NodeGroups.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "NodeGroupsClient", + "fullName": "google.cloud.compute.v1.NodeGroupsClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.NodeGroups.TestIamPermissions", + "service": { + "shortName": "NodeGroups", + "fullName": "google.cloud.compute.v1.NodeGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeTemplates_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of node templates.", + "canonical": true, + "file": "node_templates.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NodeTemplates.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NodeTemplateAggregatedList", + "client": { + "shortName": "NodeTemplatesClient", + "fullName": "google.cloud.compute.v1.NodeTemplatesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NodeTemplates.AggregatedList", + "service": { + "shortName": "NodeTemplates", + "fullName": "google.cloud.compute.v1.NodeTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeTemplates_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified NodeTemplate resource.", + "canonical": true, + "file": "node_templates.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NodeTemplates.Delete", + "async": true, + "parameters": [ + { + "name": "node_template", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NodeTemplatesClient", + "fullName": "google.cloud.compute.v1.NodeTemplatesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.NodeTemplates.Delete", + "service": { + "shortName": "NodeTemplates", + "fullName": "google.cloud.compute.v1.NodeTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeTemplates_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified node template.", + "canonical": true, + "file": "node_templates.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NodeTemplates.Get", + "async": true, + "parameters": [ + { + "name": "node_template", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NodeTemplate", + "client": { + "shortName": "NodeTemplatesClient", + "fullName": "google.cloud.compute.v1.NodeTemplatesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NodeTemplates.Get", + "service": { + "shortName": "NodeTemplates", + "fullName": "google.cloud.compute.v1.NodeTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeTemplates_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "node_templates.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.NodeTemplates.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "NodeTemplatesClient", + "fullName": "google.cloud.compute.v1.NodeTemplatesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.NodeTemplates.GetIamPolicy", + "service": { + "shortName": "NodeTemplates", + "fullName": "google.cloud.compute.v1.NodeTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeTemplates_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a NodeTemplate resource in the specified project using the data included in the request.", + "canonical": true, + "file": "node_templates.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NodeTemplates.Insert", + "async": true, + "parameters": [ + { + "name": "node_template_resource", + "type": ".google.cloud.compute.v1.NodeTemplate" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "NodeTemplatesClient", + "fullName": "google.cloud.compute.v1.NodeTemplatesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.NodeTemplates.Insert", + "service": { + "shortName": "NodeTemplates", + "fullName": "google.cloud.compute.v1.NodeTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeTemplates_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of node templates available to the specified project.", + "canonical": true, + "file": "node_templates.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NodeTemplates.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NodeTemplateList", + "client": { + "shortName": "NodeTemplatesClient", + "fullName": "google.cloud.compute.v1.NodeTemplatesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NodeTemplates.List", + "service": { + "shortName": "NodeTemplates", + "fullName": "google.cloud.compute.v1.NodeTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeTemplates_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "node_templates.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.NodeTemplates.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_policy_request_resource", + "type": ".google.cloud.compute.v1.RegionSetPolicyRequest" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "NodeTemplatesClient", + "fullName": "google.cloud.compute.v1.NodeTemplatesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.NodeTemplates.SetIamPolicy", + "service": { + "shortName": "NodeTemplates", + "fullName": "google.cloud.compute.v1.NodeTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeTemplates_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "node_templates.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.NodeTemplates.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "NodeTemplatesClient", + "fullName": "google.cloud.compute.v1.NodeTemplatesClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.NodeTemplates.TestIamPermissions", + "service": { + "shortName": "NodeTemplates", + "fullName": "google.cloud.compute.v1.NodeTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeTypes_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of node types.", + "canonical": true, + "file": "node_types.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NodeTypes.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NodeTypeAggregatedList", + "client": { + "shortName": "NodeTypesClient", + "fullName": "google.cloud.compute.v1.NodeTypesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.NodeTypes.AggregatedList", + "service": { + "shortName": "NodeTypes", + "fullName": "google.cloud.compute.v1.NodeTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeTypes_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified node type.", + "canonical": true, + "file": "node_types.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NodeTypes.Get", + "async": true, + "parameters": [ + { + "name": "node_type", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NodeType", + "client": { + "shortName": "NodeTypesClient", + "fullName": "google.cloud.compute.v1.NodeTypesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.NodeTypes.Get", + "service": { + "shortName": "NodeTypes", + "fullName": "google.cloud.compute.v1.NodeTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_NodeTypes_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of node types available to the specified project.", + "canonical": true, + "file": "node_types.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NodeTypes.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NodeTypeList", + "client": { + "shortName": "NodeTypesClient", + "fullName": "google.cloud.compute.v1.NodeTypesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.NodeTypes.List", + "service": { + "shortName": "NodeTypes", + "fullName": "google.cloud.compute.v1.NodeTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PacketMirrorings_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of packetMirrorings.", + "canonical": true, + "file": "packet_mirrorings.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.PacketMirrorings.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.PacketMirroringAggregatedList", + "client": { + "shortName": "PacketMirroringsClient", + "fullName": "google.cloud.compute.v1.PacketMirroringsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.PacketMirrorings.AggregatedList", + "service": { + "shortName": "PacketMirrorings", + "fullName": "google.cloud.compute.v1.PacketMirrorings" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PacketMirrorings_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified PacketMirroring resource.", + "canonical": true, + "file": "packet_mirrorings.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.PacketMirrorings.Delete", + "async": true, + "parameters": [ + { + "name": "packet_mirroring", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "PacketMirroringsClient", + "fullName": "google.cloud.compute.v1.PacketMirroringsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.PacketMirrorings.Delete", + "service": { + "shortName": "PacketMirrorings", + "fullName": "google.cloud.compute.v1.PacketMirrorings" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PacketMirrorings_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified PacketMirroring resource.", + "canonical": true, + "file": "packet_mirrorings.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.PacketMirrorings.Get", + "async": true, + "parameters": [ + { + "name": "packet_mirroring", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.PacketMirroring", + "client": { + "shortName": "PacketMirroringsClient", + "fullName": "google.cloud.compute.v1.PacketMirroringsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.PacketMirrorings.Get", + "service": { + "shortName": "PacketMirrorings", + "fullName": "google.cloud.compute.v1.PacketMirrorings" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PacketMirrorings_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a PacketMirroring resource in the specified project and region using the data included in the request.", + "canonical": true, + "file": "packet_mirrorings.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.PacketMirrorings.Insert", + "async": true, + "parameters": [ + { + "name": "packet_mirroring_resource", + "type": ".google.cloud.compute.v1.PacketMirroring" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "PacketMirroringsClient", + "fullName": "google.cloud.compute.v1.PacketMirroringsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.PacketMirrorings.Insert", + "service": { + "shortName": "PacketMirrorings", + "fullName": "google.cloud.compute.v1.PacketMirrorings" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PacketMirrorings_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of PacketMirroring resources available to the specified project and region.", + "canonical": true, + "file": "packet_mirrorings.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.PacketMirrorings.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.PacketMirroringList", + "client": { + "shortName": "PacketMirroringsClient", + "fullName": "google.cloud.compute.v1.PacketMirroringsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.PacketMirrorings.List", + "service": { + "shortName": "PacketMirrorings", + "fullName": "google.cloud.compute.v1.PacketMirrorings" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PacketMirrorings_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "canonical": true, + "file": "packet_mirrorings.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.PacketMirrorings.Patch", + "async": true, + "parameters": [ + { + "name": "packet_mirroring", + "type": "TYPE_STRING" + }, + { + "name": "packet_mirroring_resource", + "type": ".google.cloud.compute.v1.PacketMirroring" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "PacketMirroringsClient", + "fullName": "google.cloud.compute.v1.PacketMirroringsClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.PacketMirrorings.Patch", + "service": { + "shortName": "PacketMirrorings", + "fullName": "google.cloud.compute.v1.PacketMirrorings" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PacketMirrorings_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "packet_mirrorings.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.PacketMirrorings.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "PacketMirroringsClient", + "fullName": "google.cloud.compute.v1.PacketMirroringsClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.PacketMirrorings.TestIamPermissions", + "service": { + "shortName": "PacketMirrorings", + "fullName": "google.cloud.compute.v1.PacketMirrorings" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_DisableXpnHost_async", + "title": "AcceleratorTypes disableXpnHost Sample", + "origin": "API_DEFINITION", + "description": " Disable this project as a shared VPC host project.", + "canonical": true, + "file": "projects.disable_xpn_host.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DisableXpnHost", + "fullName": "google.cloud.compute.v1.Projects.DisableXpnHost", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "DisableXpnHost", + "fullName": "google.cloud.compute.v1.Projects.DisableXpnHost", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_DisableXpnResource_async", + "title": "AcceleratorTypes disableXpnResource Sample", + "origin": "API_DEFINITION", + "description": " Disable a service resource (also known as service project) associated with this host project.", + "canonical": true, + "file": "projects.disable_xpn_resource.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DisableXpnResource", + "fullName": "google.cloud.compute.v1.Projects.DisableXpnResource", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "projects_disable_xpn_resource_request_resource", + "type": ".google.cloud.compute.v1.ProjectsDisableXpnResourceRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "DisableXpnResource", + "fullName": "google.cloud.compute.v1.Projects.DisableXpnResource", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_EnableXpnHost_async", + "title": "AcceleratorTypes enableXpnHost Sample", + "origin": "API_DEFINITION", + "description": " Enable this project as a shared VPC host project.", + "canonical": true, + "file": "projects.enable_xpn_host.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "EnableXpnHost", + "fullName": "google.cloud.compute.v1.Projects.EnableXpnHost", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "EnableXpnHost", + "fullName": "google.cloud.compute.v1.Projects.EnableXpnHost", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_EnableXpnResource_async", + "title": "AcceleratorTypes enableXpnResource Sample", + "origin": "API_DEFINITION", + "description": " Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.", + "canonical": true, + "file": "projects.enable_xpn_resource.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "EnableXpnResource", + "fullName": "google.cloud.compute.v1.Projects.EnableXpnResource", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "projects_enable_xpn_resource_request_resource", + "type": ".google.cloud.compute.v1.ProjectsEnableXpnResourceRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "EnableXpnResource", + "fullName": "google.cloud.compute.v1.Projects.EnableXpnResource", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", + "canonical": true, + "file": "projects.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Projects.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Project", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Projects.Get", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_GetXpnHost_async", + "title": "AcceleratorTypes getXpnHost Sample", + "origin": "API_DEFINITION", + "description": " Gets the shared VPC host project that this project links to. May be empty if no link exists.", + "canonical": true, + "file": "projects.get_xpn_host.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetXpnHost", + "fullName": "google.cloud.compute.v1.Projects.GetXpnHost", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Project", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "GetXpnHost", + "fullName": "google.cloud.compute.v1.Projects.GetXpnHost", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_GetXpnResources_async", + "title": "AcceleratorTypes getXpnResources Sample", + "origin": "API_DEFINITION", + "description": " Gets service resources (a.k.a service project) associated with this host project.", + "canonical": true, + "file": "projects.get_xpn_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetXpnResources", + "fullName": "google.cloud.compute.v1.Projects.GetXpnResources", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ProjectsGetXpnResources", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "GetXpnResources", + "fullName": "google.cloud.compute.v1.Projects.GetXpnResources", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_ListXpnHosts_async", + "title": "AcceleratorTypes listXpnHosts Sample", + "origin": "API_DEFINITION", + "description": " Lists all shared VPC host projects visible to the user in an organization.", + "canonical": true, + "file": "projects.list_xpn_hosts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListXpnHosts", + "fullName": "google.cloud.compute.v1.Projects.ListXpnHosts", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "projects_list_xpn_hosts_request_resource", + "type": ".google.cloud.compute.v1.ProjectsListXpnHostsRequest" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.XpnHostList", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "ListXpnHosts", + "fullName": "google.cloud.compute.v1.Projects.ListXpnHosts", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_MoveDisk_async", + "title": "AcceleratorTypes moveDisk Sample", + "origin": "API_DEFINITION", + "description": " Moves a persistent disk from one zone to another.", + "canonical": true, + "file": "projects.move_disk.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MoveDisk", + "fullName": "google.cloud.compute.v1.Projects.MoveDisk", + "async": true, + "parameters": [ + { + "name": "disk_move_request_resource", + "type": ".google.cloud.compute.v1.DiskMoveRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "MoveDisk", + "fullName": "google.cloud.compute.v1.Projects.MoveDisk", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_MoveInstance_async", + "title": "AcceleratorTypes moveInstance Sample", + "origin": "API_DEFINITION", + "description": " Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.", + "canonical": true, + "file": "projects.move_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MoveInstance", + "fullName": "google.cloud.compute.v1.Projects.MoveInstance", + "async": true, + "parameters": [ + { + "name": "instance_move_request_resource", + "type": ".google.cloud.compute.v1.InstanceMoveRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "MoveInstance", + "fullName": "google.cloud.compute.v1.Projects.MoveInstance", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_SetCommonInstanceMetadata_async", + "title": "AcceleratorTypes setCommonInstanceMetadata Sample", + "origin": "API_DEFINITION", + "description": " Sets metadata common to all instances within the specified project using the data included in the request.", + "canonical": true, + "file": "projects.set_common_instance_metadata.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetCommonInstanceMetadata", + "fullName": "google.cloud.compute.v1.Projects.SetCommonInstanceMetadata", + "async": true, + "parameters": [ + { + "name": "metadata_resource", + "type": ".google.cloud.compute.v1.Metadata" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "SetCommonInstanceMetadata", + "fullName": "google.cloud.compute.v1.Projects.SetCommonInstanceMetadata", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_SetDefaultNetworkTier_async", + "title": "AcceleratorTypes setDefaultNetworkTier Sample", + "origin": "API_DEFINITION", + "description": " Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.", + "canonical": true, + "file": "projects.set_default_network_tier.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetDefaultNetworkTier", + "fullName": "google.cloud.compute.v1.Projects.SetDefaultNetworkTier", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "projects_set_default_network_tier_request_resource", + "type": ".google.cloud.compute.v1.ProjectsSetDefaultNetworkTierRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "SetDefaultNetworkTier", + "fullName": "google.cloud.compute.v1.Projects.SetDefaultNetworkTier", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Projects_SetUsageExportBucket_async", + "title": "AcceleratorTypes setUsageExportBucket Sample", + "origin": "API_DEFINITION", + "description": " Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.", + "canonical": true, + "file": "projects.set_usage_export_bucket.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetUsageExportBucket", + "fullName": "google.cloud.compute.v1.Projects.SetUsageExportBucket", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "usage_export_location_resource", + "type": ".google.cloud.compute.v1.UsageExportLocation" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ProjectsClient", + "fullName": "google.cloud.compute.v1.ProjectsClient" + }, + "method": { + "shortName": "SetUsageExportBucket", + "fullName": "google.cloud.compute.v1.Projects.SetUsageExportBucket", + "service": { + "shortName": "Projects", + "fullName": "google.cloud.compute.v1.Projects" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PublicAdvertisedPrefixes_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified PublicAdvertisedPrefix", + "canonical": true, + "file": "public_advertised_prefixes.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_advertised_prefix", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "PublicAdvertisedPrefixesClient", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes.Delete", + "service": { + "shortName": "PublicAdvertisedPrefixes", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PublicAdvertisedPrefixes_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified PublicAdvertisedPrefix resource.", + "canonical": true, + "file": "public_advertised_prefixes.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_advertised_prefix", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.PublicAdvertisedPrefix", + "client": { + "shortName": "PublicAdvertisedPrefixesClient", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes.Get", + "service": { + "shortName": "PublicAdvertisedPrefixes", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PublicAdvertisedPrefixes_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.", + "canonical": true, + "file": "public_advertised_prefixes.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_advertised_prefix_resource", + "type": ".google.cloud.compute.v1.PublicAdvertisedPrefix" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "PublicAdvertisedPrefixesClient", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes.Insert", + "service": { + "shortName": "PublicAdvertisedPrefixes", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PublicAdvertisedPrefixes_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists the PublicAdvertisedPrefixes for a project.", + "canonical": true, + "file": "public_advertised_prefixes.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.PublicAdvertisedPrefixList", + "client": { + "shortName": "PublicAdvertisedPrefixesClient", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes.List", + "service": { + "shortName": "PublicAdvertisedPrefixes", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PublicAdvertisedPrefixes_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "canonical": true, + "file": "public_advertised_prefixes.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_advertised_prefix", + "type": "TYPE_STRING" + }, + { + "name": "public_advertised_prefix_resource", + "type": ".google.cloud.compute.v1.PublicAdvertisedPrefix" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "PublicAdvertisedPrefixesClient", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes.Patch", + "service": { + "shortName": "PublicAdvertisedPrefixes", + "fullName": "google.cloud.compute.v1.PublicAdvertisedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PublicDelegatedPrefixes_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.", + "canonical": true, + "file": "public_delegated_prefixes.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.PublicDelegatedPrefixAggregatedList", + "client": { + "shortName": "PublicDelegatedPrefixesClient", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.AggregatedList", + "service": { + "shortName": "PublicDelegatedPrefixes", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PublicDelegatedPrefixes_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified PublicDelegatedPrefix in the given region.", + "canonical": true, + "file": "public_delegated_prefixes.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_delegated_prefix", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "PublicDelegatedPrefixesClient", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.Delete", + "service": { + "shortName": "PublicDelegatedPrefixes", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PublicDelegatedPrefixes_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified PublicDelegatedPrefix resource in the given region.", + "canonical": true, + "file": "public_delegated_prefixes.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_delegated_prefix", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.PublicDelegatedPrefix", + "client": { + "shortName": "PublicDelegatedPrefixesClient", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.Get", + "service": { + "shortName": "PublicDelegatedPrefixes", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PublicDelegatedPrefixes_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.", + "canonical": true, + "file": "public_delegated_prefixes.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_delegated_prefix_resource", + "type": ".google.cloud.compute.v1.PublicDelegatedPrefix" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "PublicDelegatedPrefixesClient", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.Insert", + "service": { + "shortName": "PublicDelegatedPrefixes", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PublicDelegatedPrefixes_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists the PublicDelegatedPrefixes for a project in the given region.", + "canonical": true, + "file": "public_delegated_prefixes.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.PublicDelegatedPrefixList", + "client": { + "shortName": "PublicDelegatedPrefixesClient", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.List", + "service": { + "shortName": "PublicDelegatedPrefixes", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_PublicDelegatedPrefixes_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "canonical": true, + "file": "public_delegated_prefixes.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "public_delegated_prefix", + "type": "TYPE_STRING" + }, + { + "name": "public_delegated_prefix_resource", + "type": ".google.cloud.compute.v1.PublicDelegatedPrefix" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "PublicDelegatedPrefixesClient", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes.Patch", + "service": { + "shortName": "PublicDelegatedPrefixes", + "fullName": "google.cloud.compute.v1.PublicDelegatedPrefixes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionAutoscalers_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified autoscaler.", + "canonical": true, + "file": "region_autoscalers.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.Delete", + "async": true, + "parameters": [ + { + "name": "autoscaler", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionAutoscalersClient", + "fullName": "google.cloud.compute.v1.RegionAutoscalersClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.Delete", + "service": { + "shortName": "RegionAutoscalers", + "fullName": "google.cloud.compute.v1.RegionAutoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionAutoscalers_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified autoscaler.", + "canonical": true, + "file": "region_autoscalers.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.Get", + "async": true, + "parameters": [ + { + "name": "autoscaler", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Autoscaler", + "client": { + "shortName": "RegionAutoscalersClient", + "fullName": "google.cloud.compute.v1.RegionAutoscalersClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.Get", + "service": { + "shortName": "RegionAutoscalers", + "fullName": "google.cloud.compute.v1.RegionAutoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionAutoscalers_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an autoscaler in the specified project using the data included in the request.", + "canonical": true, + "file": "region_autoscalers.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.Insert", + "async": true, + "parameters": [ + { + "name": "autoscaler_resource", + "type": ".google.cloud.compute.v1.Autoscaler" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionAutoscalersClient", + "fullName": "google.cloud.compute.v1.RegionAutoscalersClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.Insert", + "service": { + "shortName": "RegionAutoscalers", + "fullName": "google.cloud.compute.v1.RegionAutoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionAutoscalers_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of autoscalers contained within the specified region.", + "canonical": true, + "file": "region_autoscalers.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RegionAutoscalerList", + "client": { + "shortName": "RegionAutoscalersClient", + "fullName": "google.cloud.compute.v1.RegionAutoscalersClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.List", + "service": { + "shortName": "RegionAutoscalers", + "fullName": "google.cloud.compute.v1.RegionAutoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionAutoscalers_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "region_autoscalers.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.Patch", + "async": true, + "parameters": [ + { + "name": "autoscaler", + "type": "TYPE_STRING" + }, + { + "name": "autoscaler_resource", + "type": ".google.cloud.compute.v1.Autoscaler" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionAutoscalersClient", + "fullName": "google.cloud.compute.v1.RegionAutoscalersClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.Patch", + "service": { + "shortName": "RegionAutoscalers", + "fullName": "google.cloud.compute.v1.RegionAutoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionAutoscalers_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates an autoscaler in the specified project using the data included in the request.", + "canonical": true, + "file": "region_autoscalers.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.Update", + "async": true, + "parameters": [ + { + "name": "autoscaler", + "type": "TYPE_STRING" + }, + { + "name": "autoscaler_resource", + "type": ".google.cloud.compute.v1.Autoscaler" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionAutoscalersClient", + "fullName": "google.cloud.compute.v1.RegionAutoscalersClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionAutoscalers.Update", + "service": { + "shortName": "RegionAutoscalers", + "fullName": "google.cloud.compute.v1.RegionAutoscalers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionBackendServices_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified regional BackendService resource.", + "canonical": true, + "file": "region_backend_services.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionBackendServices.Delete", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionBackendServicesClient", + "fullName": "google.cloud.compute.v1.RegionBackendServicesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionBackendServices.Delete", + "service": { + "shortName": "RegionBackendServices", + "fullName": "google.cloud.compute.v1.RegionBackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionBackendServices_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified regional BackendService resource.", + "canonical": true, + "file": "region_backend_services.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionBackendServices.Get", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.BackendService", + "client": { + "shortName": "RegionBackendServicesClient", + "fullName": "google.cloud.compute.v1.RegionBackendServicesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionBackendServices.Get", + "service": { + "shortName": "RegionBackendServices", + "fullName": "google.cloud.compute.v1.RegionBackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionBackendServices_GetHealth_async", + "title": "AcceleratorTypes getHealth Sample", + "origin": "API_DEFINITION", + "description": " Gets the most recent health check results for this regional BackendService.", + "canonical": true, + "file": "region_backend_services.get_health.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetHealth", + "fullName": "google.cloud.compute.v1.RegionBackendServices.GetHealth", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource_group_reference_resource", + "type": ".google.cloud.compute.v1.ResourceGroupReference" + } + ], + "resultType": ".google.cloud.compute.v1.BackendServiceGroupHealth", + "client": { + "shortName": "RegionBackendServicesClient", + "fullName": "google.cloud.compute.v1.RegionBackendServicesClient" + }, + "method": { + "shortName": "GetHealth", + "fullName": "google.cloud.compute.v1.RegionBackendServices.GetHealth", + "service": { + "shortName": "RegionBackendServices", + "fullName": "google.cloud.compute.v1.RegionBackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionBackendServices_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "region_backend_services.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionBackendServices.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "RegionBackendServicesClient", + "fullName": "google.cloud.compute.v1.RegionBackendServicesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionBackendServices.GetIamPolicy", + "service": { + "shortName": "RegionBackendServices", + "fullName": "google.cloud.compute.v1.RegionBackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionBackendServices_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.", + "canonical": true, + "file": "region_backend_services.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionBackendServices.Insert", + "async": true, + "parameters": [ + { + "name": "backend_service_resource", + "type": ".google.cloud.compute.v1.BackendService" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionBackendServicesClient", + "fullName": "google.cloud.compute.v1.RegionBackendServicesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionBackendServices.Insert", + "service": { + "shortName": "RegionBackendServices", + "fullName": "google.cloud.compute.v1.RegionBackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionBackendServices_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of regional BackendService resources available to the specified project in the given region.", + "canonical": true, + "file": "region_backend_services.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionBackendServices.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.BackendServiceList", + "client": { + "shortName": "RegionBackendServicesClient", + "fullName": "google.cloud.compute.v1.RegionBackendServicesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionBackendServices.List", + "service": { + "shortName": "RegionBackendServices", + "fullName": "google.cloud.compute.v1.RegionBackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionBackendServices_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "region_backend_services.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionBackendServices.Patch", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "backend_service_resource", + "type": ".google.cloud.compute.v1.BackendService" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionBackendServicesClient", + "fullName": "google.cloud.compute.v1.RegionBackendServicesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionBackendServices.Patch", + "service": { + "shortName": "RegionBackendServices", + "fullName": "google.cloud.compute.v1.RegionBackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionBackendServices_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "region_backend_services.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionBackendServices.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_policy_request_resource", + "type": ".google.cloud.compute.v1.RegionSetPolicyRequest" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "RegionBackendServicesClient", + "fullName": "google.cloud.compute.v1.RegionBackendServicesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionBackendServices.SetIamPolicy", + "service": { + "shortName": "RegionBackendServices", + "fullName": "google.cloud.compute.v1.RegionBackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionBackendServices_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .", + "canonical": true, + "file": "region_backend_services.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionBackendServices.Update", + "async": true, + "parameters": [ + { + "name": "backend_service", + "type": "TYPE_STRING" + }, + { + "name": "backend_service_resource", + "type": ".google.cloud.compute.v1.BackendService" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionBackendServicesClient", + "fullName": "google.cloud.compute.v1.RegionBackendServicesClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionBackendServices.Update", + "service": { + "shortName": "RegionBackendServices", + "fullName": "google.cloud.compute.v1.RegionBackendServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionCommitments_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of commitments by region.", + "canonical": true, + "file": "region_commitments.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.RegionCommitments.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.CommitmentAggregatedList", + "client": { + "shortName": "RegionCommitmentsClient", + "fullName": "google.cloud.compute.v1.RegionCommitmentsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.RegionCommitments.AggregatedList", + "service": { + "shortName": "RegionCommitments", + "fullName": "google.cloud.compute.v1.RegionCommitments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionCommitments_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified commitment resource.", + "canonical": true, + "file": "region_commitments.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionCommitments.Get", + "async": true, + "parameters": [ + { + "name": "commitment", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Commitment", + "client": { + "shortName": "RegionCommitmentsClient", + "fullName": "google.cloud.compute.v1.RegionCommitmentsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionCommitments.Get", + "service": { + "shortName": "RegionCommitments", + "fullName": "google.cloud.compute.v1.RegionCommitments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionCommitments_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a commitment in the specified project using the data included in the request.", + "canonical": true, + "file": "region_commitments.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionCommitments.Insert", + "async": true, + "parameters": [ + { + "name": "commitment_resource", + "type": ".google.cloud.compute.v1.Commitment" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionCommitmentsClient", + "fullName": "google.cloud.compute.v1.RegionCommitmentsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionCommitments.Insert", + "service": { + "shortName": "RegionCommitments", + "fullName": "google.cloud.compute.v1.RegionCommitments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionCommitments_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of commitments contained within the specified region.", + "canonical": true, + "file": "region_commitments.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionCommitments.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.CommitmentList", + "client": { + "shortName": "RegionCommitmentsClient", + "fullName": "google.cloud.compute.v1.RegionCommitmentsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionCommitments.List", + "service": { + "shortName": "RegionCommitments", + "fullName": "google.cloud.compute.v1.RegionCommitments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionCommitments_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.", + "canonical": true, + "file": "region_commitments.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionCommitments.Update", + "async": true, + "parameters": [ + { + "name": "commitment", + "type": "TYPE_STRING" + }, + { + "name": "commitment_resource", + "type": ".google.cloud.compute.v1.Commitment" + }, + { + "name": "paths", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "update_mask", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionCommitmentsClient", + "fullName": "google.cloud.compute.v1.RegionCommitmentsClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionCommitments.Update", + "service": { + "shortName": "RegionCommitments", + "fullName": "google.cloud.compute.v1.RegionCommitments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_AddResourcePolicies_async", + "title": "AcceleratorTypes addResourcePolicies Sample", + "origin": "API_DEFINITION", + "description": " Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.", + "canonical": true, + "file": "region_disks.add_resource_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddResourcePolicies", + "fullName": "google.cloud.compute.v1.RegionDisks.AddResourcePolicies", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_disks_add_resource_policies_request_resource", + "type": ".google.cloud.compute.v1.RegionDisksAddResourcePoliciesRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "AddResourcePolicies", + "fullName": "google.cloud.compute.v1.RegionDisks.AddResourcePolicies", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_BulkInsert_async", + "title": "AcceleratorTypes bulkInsert Sample", + "origin": "API_DEFINITION", + "description": " Bulk create a set of disks.", + "canonical": true, + "file": "region_disks.bulk_insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BulkInsert", + "fullName": "google.cloud.compute.v1.RegionDisks.BulkInsert", + "async": true, + "parameters": [ + { + "name": "bulk_insert_disk_resource_resource", + "type": ".google.cloud.compute.v1.BulkInsertDiskResource" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "BulkInsert", + "fullName": "google.cloud.compute.v1.RegionDisks.BulkInsert", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_CreateSnapshot_async", + "title": "AcceleratorTypes createSnapshot Sample", + "origin": "API_DEFINITION", + "description": " Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.", + "canonical": true, + "file": "region_disks.create_snapshot.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSnapshot", + "fullName": "google.cloud.compute.v1.RegionDisks.CreateSnapshot", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "snapshot_resource", + "type": ".google.cloud.compute.v1.Snapshot" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "CreateSnapshot", + "fullName": "google.cloud.compute.v1.RegionDisks.CreateSnapshot", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.", + "canonical": true, + "file": "region_disks.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionDisks.Delete", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionDisks.Delete", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns a specified regional persistent disk.", + "canonical": true, + "file": "region_disks.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionDisks.Get", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Disk", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionDisks.Get", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "region_disks.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionDisks.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionDisks.GetIamPolicy", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a persistent regional disk in the specified project using the data included in the request.", + "canonical": true, + "file": "region_disks.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionDisks.Insert", + "async": true, + "parameters": [ + { + "name": "disk_resource", + "type": ".google.cloud.compute.v1.Disk" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "source_image", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionDisks.Insert", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of persistent disks contained within the specified region.", + "canonical": true, + "file": "region_disks.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionDisks.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.DiskList", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionDisks.List", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_RemoveResourcePolicies_async", + "title": "AcceleratorTypes removeResourcePolicies Sample", + "origin": "API_DEFINITION", + "description": " Removes resource policies from a regional disk.", + "canonical": true, + "file": "region_disks.remove_resource_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveResourcePolicies", + "fullName": "google.cloud.compute.v1.RegionDisks.RemoveResourcePolicies", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_disks_remove_resource_policies_request_resource", + "type": ".google.cloud.compute.v1.RegionDisksRemoveResourcePoliciesRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "RemoveResourcePolicies", + "fullName": "google.cloud.compute.v1.RegionDisks.RemoveResourcePolicies", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_Resize_async", + "title": "AcceleratorTypes resize Sample", + "origin": "API_DEFINITION", + "description": " Resizes the specified regional persistent disk.", + "canonical": true, + "file": "region_disks.resize.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Resize", + "fullName": "google.cloud.compute.v1.RegionDisks.Resize", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_disks_resize_request_resource", + "type": ".google.cloud.compute.v1.RegionDisksResizeRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "Resize", + "fullName": "google.cloud.compute.v1.RegionDisks.Resize", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "region_disks.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionDisks.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_policy_request_resource", + "type": ".google.cloud.compute.v1.RegionSetPolicyRequest" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionDisks.SetIamPolicy", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on the target regional disk.", + "canonical": true, + "file": "region_disks.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.RegionDisks.SetLabels", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_labels_request_resource", + "type": ".google.cloud.compute.v1.RegionSetLabelsRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.RegionDisks.SetLabels", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_StartAsyncReplication_async", + "title": "AcceleratorTypes startAsyncReplication Sample", + "origin": "API_DEFINITION", + "description": " Starts asynchronous replication. Must be invoked on the primary disk.", + "canonical": true, + "file": "region_disks.start_async_replication.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StartAsyncReplication", + "fullName": "google.cloud.compute.v1.RegionDisks.StartAsyncReplication", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_disks_start_async_replication_request_resource", + "type": ".google.cloud.compute.v1.RegionDisksStartAsyncReplicationRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "StartAsyncReplication", + "fullName": "google.cloud.compute.v1.RegionDisks.StartAsyncReplication", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_StopAsyncReplication_async", + "title": "AcceleratorTypes stopAsyncReplication Sample", + "origin": "API_DEFINITION", + "description": " Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.", + "canonical": true, + "file": "region_disks.stop_async_replication.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StopAsyncReplication", + "fullName": "google.cloud.compute.v1.RegionDisks.StopAsyncReplication", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "StopAsyncReplication", + "fullName": "google.cloud.compute.v1.RegionDisks.StopAsyncReplication", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_StopGroupAsyncReplication_async", + "title": "AcceleratorTypes stopGroupAsyncReplication Sample", + "origin": "API_DEFINITION", + "description": " Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.", + "canonical": true, + "file": "region_disks.stop_group_async_replication.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StopGroupAsyncReplication", + "fullName": "google.cloud.compute.v1.RegionDisks.StopGroupAsyncReplication", + "async": true, + "parameters": [ + { + "name": "disks_stop_group_async_replication_resource_resource", + "type": ".google.cloud.compute.v1.DisksStopGroupAsyncReplicationResource" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "StopGroupAsyncReplication", + "fullName": "google.cloud.compute.v1.RegionDisks.StopGroupAsyncReplication", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "region_disks.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.RegionDisks.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.RegionDisks.TestIamPermissions", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDisks_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.", + "canonical": true, + "file": "region_disks.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionDisks.Update", + "async": true, + "parameters": [ + { + "name": "disk", + "type": "TYPE_STRING" + }, + { + "name": "disk_resource", + "type": ".google.cloud.compute.v1.Disk" + }, + { + "name": "paths", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "update_mask", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionDisksClient", + "fullName": "google.cloud.compute.v1.RegionDisksClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionDisks.Update", + "service": { + "shortName": "RegionDisks", + "fullName": "google.cloud.compute.v1.RegionDisks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDiskTypes_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified regional disk type.", + "canonical": true, + "file": "region_disk_types.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionDiskTypes.Get", + "async": true, + "parameters": [ + { + "name": "disk_type", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.DiskType", + "client": { + "shortName": "RegionDiskTypesClient", + "fullName": "google.cloud.compute.v1.RegionDiskTypesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionDiskTypes.Get", + "service": { + "shortName": "RegionDiskTypes", + "fullName": "google.cloud.compute.v1.RegionDiskTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionDiskTypes_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of regional disk types available to the specified project.", + "canonical": true, + "file": "region_disk_types.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionDiskTypes.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RegionDiskTypeList", + "client": { + "shortName": "RegionDiskTypesClient", + "fullName": "google.cloud.compute.v1.RegionDiskTypesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionDiskTypes.List", + "service": { + "shortName": "RegionDiskTypes", + "fullName": "google.cloud.compute.v1.RegionDiskTypes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionHealthChecks_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified HealthCheck resource.", + "canonical": true, + "file": "region_health_checks.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.Delete", + "async": true, + "parameters": [ + { + "name": "health_check", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionHealthChecksClient", + "fullName": "google.cloud.compute.v1.RegionHealthChecksClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.Delete", + "service": { + "shortName": "RegionHealthChecks", + "fullName": "google.cloud.compute.v1.RegionHealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionHealthChecks_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified HealthCheck resource.", + "canonical": true, + "file": "region_health_checks.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.Get", + "async": true, + "parameters": [ + { + "name": "health_check", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.HealthCheck", + "client": { + "shortName": "RegionHealthChecksClient", + "fullName": "google.cloud.compute.v1.RegionHealthChecksClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.Get", + "service": { + "shortName": "RegionHealthChecks", + "fullName": "google.cloud.compute.v1.RegionHealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionHealthChecks_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a HealthCheck resource in the specified project using the data included in the request.", + "canonical": true, + "file": "region_health_checks.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.Insert", + "async": true, + "parameters": [ + { + "name": "health_check_resource", + "type": ".google.cloud.compute.v1.HealthCheck" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionHealthChecksClient", + "fullName": "google.cloud.compute.v1.RegionHealthChecksClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.Insert", + "service": { + "shortName": "RegionHealthChecks", + "fullName": "google.cloud.compute.v1.RegionHealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionHealthChecks_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of HealthCheck resources available to the specified project.", + "canonical": true, + "file": "region_health_checks.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.HealthCheckList", + "client": { + "shortName": "RegionHealthChecksClient", + "fullName": "google.cloud.compute.v1.RegionHealthChecksClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.List", + "service": { + "shortName": "RegionHealthChecks", + "fullName": "google.cloud.compute.v1.RegionHealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionHealthChecks_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "region_health_checks.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.Patch", + "async": true, + "parameters": [ + { + "name": "health_check", + "type": "TYPE_STRING" + }, + { + "name": "health_check_resource", + "type": ".google.cloud.compute.v1.HealthCheck" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionHealthChecksClient", + "fullName": "google.cloud.compute.v1.RegionHealthChecksClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.Patch", + "service": { + "shortName": "RegionHealthChecks", + "fullName": "google.cloud.compute.v1.RegionHealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionHealthChecks_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates a HealthCheck resource in the specified project using the data included in the request.", + "canonical": true, + "file": "region_health_checks.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.Update", + "async": true, + "parameters": [ + { + "name": "health_check", + "type": "TYPE_STRING" + }, + { + "name": "health_check_resource", + "type": ".google.cloud.compute.v1.HealthCheck" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionHealthChecksClient", + "fullName": "google.cloud.compute.v1.RegionHealthChecksClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionHealthChecks.Update", + "service": { + "shortName": "RegionHealthChecks", + "fullName": "google.cloud.compute.v1.RegionHealthChecks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionHealthCheckServices_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified regional HealthCheckService.", + "canonical": true, + "file": "region_health_check_services.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices.Delete", + "async": true, + "parameters": [ + { + "name": "health_check_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionHealthCheckServicesClient", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServicesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices.Delete", + "service": { + "shortName": "RegionHealthCheckServices", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionHealthCheckServices_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified regional HealthCheckService resource.", + "canonical": true, + "file": "region_health_check_services.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices.Get", + "async": true, + "parameters": [ + { + "name": "health_check_service", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.HealthCheckService", + "client": { + "shortName": "RegionHealthCheckServicesClient", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServicesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices.Get", + "service": { + "shortName": "RegionHealthCheckServices", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionHealthCheckServices_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.", + "canonical": true, + "file": "region_health_check_services.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices.Insert", + "async": true, + "parameters": [ + { + "name": "health_check_service_resource", + "type": ".google.cloud.compute.v1.HealthCheckService" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionHealthCheckServicesClient", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServicesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices.Insert", + "service": { + "shortName": "RegionHealthCheckServices", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionHealthCheckServices_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists all the HealthCheckService resources that have been configured for the specified project in the given region.", + "canonical": true, + "file": "region_health_check_services.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.HealthCheckServicesList", + "client": { + "shortName": "RegionHealthCheckServicesClient", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServicesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices.List", + "service": { + "shortName": "RegionHealthCheckServices", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionHealthCheckServices_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "region_health_check_services.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices.Patch", + "async": true, + "parameters": [ + { + "name": "health_check_service", + "type": "TYPE_STRING" + }, + { + "name": "health_check_service_resource", + "type": ".google.cloud.compute.v1.HealthCheckService" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionHealthCheckServicesClient", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServicesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices.Patch", + "service": { + "shortName": "RegionHealthCheckServices", + "fullName": "google.cloud.compute.v1.RegionHealthCheckServices" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_AbandonInstances_async", + "title": "AcceleratorTypes abandonInstances Sample", + "origin": "API_DEFINITION", + "description": " Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.", + "canonical": true, + "file": "region_instance_group_managers.abandon_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AbandonInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.AbandonInstances", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_group_managers_abandon_instances_request_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupManagersAbandonInstancesRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "AbandonInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.AbandonInstances", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_ApplyUpdatesToInstances_async", + "title": "AcceleratorTypes applyUpdatesToInstances Sample", + "origin": "API_DEFINITION", + "description": " Apply updates to selected instances the managed instance group.", + "canonical": true, + "file": "region_instance_group_managers.apply_updates_to_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ApplyUpdatesToInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.ApplyUpdatesToInstances", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_group_managers_apply_updates_request_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupManagersApplyUpdatesRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "ApplyUpdatesToInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.ApplyUpdatesToInstances", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_CreateInstances_async", + "title": "AcceleratorTypes createInstances Sample", + "origin": "API_DEFINITION", + "description": " Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.", + "canonical": true, + "file": "region_instance_group_managers.create_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.CreateInstances", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_group_managers_create_instances_request_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupManagersCreateInstancesRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "CreateInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.CreateInstances", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified managed instance group and all of the instances in that group.", + "canonical": true, + "file": "region_instance_group_managers.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.Delete", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.Delete", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_DeleteInstances_async", + "title": "AcceleratorTypes deleteInstances Sample", + "origin": "API_DEFINITION", + "description": " Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.", + "canonical": true, + "file": "region_instance_group_managers.delete_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.DeleteInstances", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_group_managers_delete_instances_request_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupManagersDeleteInstancesRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "DeleteInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.DeleteInstances", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_DeletePerInstanceConfigs_async", + "title": "AcceleratorTypes deletePerInstanceConfigs Sample", + "origin": "API_DEFINITION", + "description": " Deletes selected per-instance configurations for the managed instance group.", + "canonical": true, + "file": "region_instance_group_managers.delete_per_instance_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeletePerInstanceConfigs", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.DeletePerInstanceConfigs", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_group_manager_delete_instance_config_req_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupManagerDeleteInstanceConfigReq" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "DeletePerInstanceConfigs", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.DeletePerInstanceConfigs", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns all of the details about the specified managed instance group.", + "canonical": true, + "file": "region_instance_group_managers.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.Get", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroupManager", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.Get", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances.", + "canonical": true, + "file": "region_instance_group_managers.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.Insert", + "async": true, + "parameters": [ + { + "name": "instance_group_manager_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManager" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.Insert", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of managed instance groups that are contained within the specified region.", + "canonical": true, + "file": "region_instance_group_managers.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RegionInstanceGroupManagerList", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.List", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_ListErrors_async", + "title": "AcceleratorTypes listErrors Sample", + "origin": "API_DEFINITION", + "description": " Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.", + "canonical": true, + "file": "region_instance_group_managers.list_errors.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListErrors", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.ListErrors", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RegionInstanceGroupManagersListErrorsResponse", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "ListErrors", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.ListErrors", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_ListManagedInstances_async", + "title": "AcceleratorTypes listManagedInstances Sample", + "origin": "API_DEFINITION", + "description": " Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.", + "canonical": true, + "file": "region_instance_group_managers.list_managed_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListManagedInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.ListManagedInstances", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RegionInstanceGroupManagersListInstancesResponse", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "ListManagedInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.ListManagedInstances", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_ListPerInstanceConfigs_async", + "title": "AcceleratorTypes listPerInstanceConfigs Sample", + "origin": "API_DEFINITION", + "description": " Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.", + "canonical": true, + "file": "region_instance_group_managers.list_per_instance_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPerInstanceConfigs", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.ListPerInstanceConfigs", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RegionInstanceGroupManagersListInstanceConfigsResp", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "ListPerInstanceConfigs", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.ListPerInstanceConfigs", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.", + "canonical": true, + "file": "region_instance_group_managers.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.Patch", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "instance_group_manager_resource", + "type": ".google.cloud.compute.v1.InstanceGroupManager" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.Patch", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_PatchPerInstanceConfigs_async", + "title": "AcceleratorTypes patchPerInstanceConfigs Sample", + "origin": "API_DEFINITION", + "description": " Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.", + "canonical": true, + "file": "region_instance_group_managers.patch_per_instance_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PatchPerInstanceConfigs", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.PatchPerInstanceConfigs", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_group_manager_patch_instance_config_req_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupManagerPatchInstanceConfigReq" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "PatchPerInstanceConfigs", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.PatchPerInstanceConfigs", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_RecreateInstances_async", + "title": "AcceleratorTypes recreateInstances Sample", + "origin": "API_DEFINITION", + "description": " Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.", + "canonical": true, + "file": "region_instance_group_managers.recreate_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RecreateInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.RecreateInstances", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_group_managers_recreate_request_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupManagersRecreateRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "RecreateInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.RecreateInstances", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_Resize_async", + "title": "AcceleratorTypes resize Sample", + "origin": "API_DEFINITION", + "description": " Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.", + "canonical": true, + "file": "region_instance_group_managers.resize.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Resize", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.Resize", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "Resize", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.Resize", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_SetInstanceTemplate_async", + "title": "AcceleratorTypes setInstanceTemplate Sample", + "origin": "API_DEFINITION", + "description": " Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.", + "canonical": true, + "file": "region_instance_group_managers.set_instance_template.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetInstanceTemplate", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.SetInstanceTemplate", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_group_managers_set_template_request_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupManagersSetTemplateRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "SetInstanceTemplate", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.SetInstanceTemplate", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_SetTargetPools_async", + "title": "AcceleratorTypes setTargetPools Sample", + "origin": "API_DEFINITION", + "description": " Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.", + "canonical": true, + "file": "region_instance_group_managers.set_target_pools.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetTargetPools", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.SetTargetPools", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_group_managers_set_target_pools_request_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupManagersSetTargetPoolsRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "SetTargetPools", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.SetTargetPools", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroupManagers_UpdatePerInstanceConfigs_async", + "title": "AcceleratorTypes updatePerInstanceConfigs Sample", + "origin": "API_DEFINITION", + "description": " Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.", + "canonical": true, + "file": "region_instance_group_managers.update_per_instance_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdatePerInstanceConfigs", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.UpdatePerInstanceConfigs", + "async": true, + "parameters": [ + { + "name": "instance_group_manager", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_group_manager_update_instance_config_req_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupManagerUpdateInstanceConfigReq" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupManagersClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagersClient" + }, + "method": { + "shortName": "UpdatePerInstanceConfigs", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers.UpdatePerInstanceConfigs", + "service": { + "shortName": "RegionInstanceGroupManagers", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupManagers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroups_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified instance group resource.", + "canonical": true, + "file": "region_instance_groups.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups.Get", + "async": true, + "parameters": [ + { + "name": "instance_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceGroup", + "client": { + "shortName": "RegionInstanceGroupsClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups.Get", + "service": { + "shortName": "RegionInstanceGroups", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroups_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of instance group resources contained within the specified region.", + "canonical": true, + "file": "region_instance_groups.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RegionInstanceGroupList", + "client": { + "shortName": "RegionInstanceGroupsClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups.List", + "service": { + "shortName": "RegionInstanceGroups", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroups_ListInstances_async", + "title": "AcceleratorTypes listInstances Sample", + "origin": "API_DEFINITION", + "description": " Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.", + "canonical": true, + "file": "region_instance_groups.list_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups.ListInstances", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "instance_group", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_groups_list_instances_request_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupsListInstancesRequest" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RegionInstanceGroupsListInstances", + "client": { + "shortName": "RegionInstanceGroupsClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupsClient" + }, + "method": { + "shortName": "ListInstances", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups.ListInstances", + "service": { + "shortName": "RegionInstanceGroups", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceGroups_SetNamedPorts_async", + "title": "AcceleratorTypes setNamedPorts Sample", + "origin": "API_DEFINITION", + "description": " Sets the named ports for the specified regional instance group.", + "canonical": true, + "file": "region_instance_groups.set_named_ports.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetNamedPorts", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups.SetNamedPorts", + "async": true, + "parameters": [ + { + "name": "instance_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_instance_groups_set_named_ports_request_resource", + "type": ".google.cloud.compute.v1.RegionInstanceGroupsSetNamedPortsRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceGroupsClient", + "fullName": "google.cloud.compute.v1.RegionInstanceGroupsClient" + }, + "method": { + "shortName": "SetNamedPorts", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups.SetNamedPorts", + "service": { + "shortName": "RegionInstanceGroups", + "fullName": "google.cloud.compute.v1.RegionInstanceGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstances_BulkInsert_async", + "title": "AcceleratorTypes bulkInsert Sample", + "origin": "API_DEFINITION", + "description": " Creates multiple instances in a given region. Count specifies the number of instances to create.", + "canonical": true, + "file": "region_instances.bulk_insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BulkInsert", + "fullName": "google.cloud.compute.v1.RegionInstances.BulkInsert", + "async": true, + "parameters": [ + { + "name": "bulk_insert_instance_resource_resource", + "type": ".google.cloud.compute.v1.BulkInsertInstanceResource" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstancesClient", + "fullName": "google.cloud.compute.v1.RegionInstancesClient" + }, + "method": { + "shortName": "BulkInsert", + "fullName": "google.cloud.compute.v1.RegionInstances.BulkInsert", + "service": { + "shortName": "RegionInstances", + "fullName": "google.cloud.compute.v1.RegionInstances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceTemplates_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone.", + "canonical": true, + "file": "region_instance_templates.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates.Delete", + "async": true, + "parameters": [ + { + "name": "instance_template", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplatesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates.Delete", + "service": { + "shortName": "RegionInstanceTemplates", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceTemplates_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified instance template.", + "canonical": true, + "file": "region_instance_templates.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates.Get", + "async": true, + "parameters": [ + { + "name": "instance_template", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceTemplate", + "client": { + "shortName": "RegionInstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplatesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates.Get", + "service": { + "shortName": "RegionInstanceTemplates", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceTemplates_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an instance template in the specified project and region using the global instance template whose URL is included in the request.", + "canonical": true, + "file": "region_instance_templates.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates.Insert", + "async": true, + "parameters": [ + { + "name": "instance_template_resource", + "type": ".google.cloud.compute.v1.InstanceTemplate" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionInstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplatesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates.Insert", + "service": { + "shortName": "RegionInstanceTemplates", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionInstanceTemplates_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of instance templates that are contained within the specified project and region.", + "canonical": true, + "file": "region_instance_templates.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.InstanceTemplateList", + "client": { + "shortName": "RegionInstanceTemplatesClient", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplatesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates.List", + "service": { + "shortName": "RegionInstanceTemplates", + "fullName": "google.cloud.compute.v1.RegionInstanceTemplates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkEndpointGroups_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.", + "canonical": true, + "file": "region_network_endpoint_groups.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups.Delete", + "async": true, + "parameters": [ + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroupsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups.Delete", + "service": { + "shortName": "RegionNetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkEndpointGroups_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified network endpoint group.", + "canonical": true, + "file": "region_network_endpoint_groups.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups.Get", + "async": true, + "parameters": [ + { + "name": "network_endpoint_group", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkEndpointGroup", + "client": { + "shortName": "RegionNetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroupsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups.Get", + "service": { + "shortName": "RegionNetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkEndpointGroups_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a network endpoint group in the specified project using the parameters that are included in the request.", + "canonical": true, + "file": "region_network_endpoint_groups.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups.Insert", + "async": true, + "parameters": [ + { + "name": "network_endpoint_group_resource", + "type": ".google.cloud.compute.v1.NetworkEndpointGroup" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroupsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups.Insert", + "service": { + "shortName": "RegionNetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkEndpointGroups_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of regional network endpoint groups available to the specified project in the given region.", + "canonical": true, + "file": "region_network_endpoint_groups.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NetworkEndpointGroupList", + "client": { + "shortName": "RegionNetworkEndpointGroupsClient", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroupsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups.List", + "service": { + "shortName": "RegionNetworkEndpointGroups", + "fullName": "google.cloud.compute.v1.RegionNetworkEndpointGroups" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_AddAssociation_async", + "title": "AcceleratorTypes addAssociation Sample", + "origin": "API_DEFINITION", + "description": " Inserts an association for the specified network firewall policy.", + "canonical": true, + "file": "region_network_firewall_policies.add_association.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddAssociation", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.AddAssociation", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_association_resource", + "type": ".google.cloud.compute.v1.FirewallPolicyAssociation" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "replace_existing_association", + "type": "TYPE_BOOL" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "AddAssociation", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.AddAssociation", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_AddRule_async", + "title": "AcceleratorTypes addRule Sample", + "origin": "API_DEFINITION", + "description": " Inserts a rule into a network firewall policy.", + "canonical": true, + "file": "region_network_firewall_policies.add_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddRule", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.AddRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_rule_resource", + "type": ".google.cloud.compute.v1.FirewallPolicyRule" + }, + { + "name": "max_priority", + "type": "TYPE_INT32" + }, + { + "name": "min_priority", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "AddRule", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.AddRule", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_CloneRules_async", + "title": "AcceleratorTypes cloneRules Sample", + "origin": "API_DEFINITION", + "description": " Copies rules to the specified network firewall policy.", + "canonical": true, + "file": "region_network_firewall_policies.clone_rules.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CloneRules", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.CloneRules", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "source_firewall_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "CloneRules", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.CloneRules", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified network firewall policy.", + "canonical": true, + "file": "region_network_firewall_policies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.Delete", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.Delete", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified network firewall policy.", + "canonical": true, + "file": "region_network_firewall_policies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.Get", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicy", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.Get", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_GetAssociation_async", + "title": "AcceleratorTypes getAssociation Sample", + "origin": "API_DEFINITION", + "description": " Gets an association with the specified name.", + "canonical": true, + "file": "region_network_firewall_policies.get_association.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAssociation", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.GetAssociation", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicyAssociation", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "GetAssociation", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.GetAssociation", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_GetEffectiveFirewalls_async", + "title": "AcceleratorTypes getEffectiveFirewalls Sample", + "origin": "API_DEFINITION", + "description": " Returns the effective firewalls on a given network.", + "canonical": true, + "file": "region_network_firewall_policies.get_effective_firewalls.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEffectiveFirewalls", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.GetEffectiveFirewalls", + "async": true, + "parameters": [ + { + "name": "network", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "GetEffectiveFirewalls", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.GetEffectiveFirewalls", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "region_network_firewall_policies.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.GetIamPolicy", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_GetRule_async", + "title": "AcceleratorTypes getRule Sample", + "origin": "API_DEFINITION", + "description": " Gets a rule of the specified priority.", + "canonical": true, + "file": "region_network_firewall_policies.get_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetRule", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.GetRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "priority", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicyRule", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "GetRule", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.GetRule", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a new network firewall policy in the specified project and region.", + "canonical": true, + "file": "region_network_firewall_policies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.Insert", + "async": true, + "parameters": [ + { + "name": "firewall_policy_resource", + "type": ".google.cloud.compute.v1.FirewallPolicy" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.Insert", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists all the network firewall policies that have been configured for the specified project in the given region.", + "canonical": true, + "file": "region_network_firewall_policies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.FirewallPolicyList", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.List", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified network firewall policy.", + "canonical": true, + "file": "region_network_firewall_policies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.Patch", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_resource", + "type": ".google.cloud.compute.v1.FirewallPolicy" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.Patch", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_PatchRule_async", + "title": "AcceleratorTypes patchRule Sample", + "origin": "API_DEFINITION", + "description": " Patches a rule of the specified priority.", + "canonical": true, + "file": "region_network_firewall_policies.patch_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PatchRule", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.PatchRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "firewall_policy_rule_resource", + "type": ".google.cloud.compute.v1.FirewallPolicyRule" + }, + { + "name": "priority", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "PatchRule", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.PatchRule", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_RemoveAssociation_async", + "title": "AcceleratorTypes removeAssociation Sample", + "origin": "API_DEFINITION", + "description": " Removes an association for the specified network firewall policy.", + "canonical": true, + "file": "region_network_firewall_policies.remove_association.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveAssociation", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.RemoveAssociation", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "RemoveAssociation", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.RemoveAssociation", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_RemoveRule_async", + "title": "AcceleratorTypes removeRule Sample", + "origin": "API_DEFINITION", + "description": " Deletes a rule of the specified priority.", + "canonical": true, + "file": "region_network_firewall_policies.remove_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveRule", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.RemoveRule", + "async": true, + "parameters": [ + { + "name": "firewall_policy", + "type": "TYPE_STRING" + }, + { + "name": "priority", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "RemoveRule", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.RemoveRule", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "region_network_firewall_policies.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_policy_request_resource", + "type": ".google.cloud.compute.v1.RegionSetPolicyRequest" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.SetIamPolicy", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNetworkFirewallPolicies_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "region_network_firewall_policies.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "RegionNetworkFirewallPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPoliciesClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies.TestIamPermissions", + "service": { + "shortName": "RegionNetworkFirewallPolicies", + "fullName": "google.cloud.compute.v1.RegionNetworkFirewallPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNotificationEndpoints_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified NotificationEndpoint in the given region", + "canonical": true, + "file": "region_notification_endpoints.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints.Delete", + "async": true, + "parameters": [ + { + "name": "notification_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNotificationEndpointsClient", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpointsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints.Delete", + "service": { + "shortName": "RegionNotificationEndpoints", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNotificationEndpoints_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified NotificationEndpoint resource in the given region.", + "canonical": true, + "file": "region_notification_endpoints.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints.Get", + "async": true, + "parameters": [ + { + "name": "notification_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.NotificationEndpoint", + "client": { + "shortName": "RegionNotificationEndpointsClient", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpointsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints.Get", + "service": { + "shortName": "RegionNotificationEndpoints", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNotificationEndpoints_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.", + "canonical": true, + "file": "region_notification_endpoints.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints.Insert", + "async": true, + "parameters": [ + { + "name": "notification_endpoint_resource", + "type": ".google.cloud.compute.v1.NotificationEndpoint" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionNotificationEndpointsClient", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpointsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints.Insert", + "service": { + "shortName": "RegionNotificationEndpoints", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionNotificationEndpoints_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists the NotificationEndpoints for a project in the given region.", + "canonical": true, + "file": "region_notification_endpoints.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.NotificationEndpointList", + "client": { + "shortName": "RegionNotificationEndpointsClient", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpointsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints.List", + "service": { + "shortName": "RegionNotificationEndpoints", + "fullName": "google.cloud.compute.v1.RegionNotificationEndpoints" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionOperations_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified region-specific Operations resource.", + "canonical": true, + "file": "region_operations.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionOperations.Delete", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.DeleteRegionOperationResponse", + "client": { + "shortName": "RegionOperationsClient", + "fullName": "google.cloud.compute.v1.RegionOperationsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionOperations.Delete", + "service": { + "shortName": "RegionOperations", + "fullName": "google.cloud.compute.v1.RegionOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionOperations_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the specified region-specific Operations resource.", + "canonical": true, + "file": "region_operations.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionOperations.Get", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionOperationsClient", + "fullName": "google.cloud.compute.v1.RegionOperationsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionOperations.Get", + "service": { + "shortName": "RegionOperations", + "fullName": "google.cloud.compute.v1.RegionOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionOperations_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of Operation resources contained within the specified region.", + "canonical": true, + "file": "region_operations.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionOperations.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.OperationList", + "client": { + "shortName": "RegionOperationsClient", + "fullName": "google.cloud.compute.v1.RegionOperationsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionOperations.List", + "service": { + "shortName": "RegionOperations", + "fullName": "google.cloud.compute.v1.RegionOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionOperations_Wait_async", + "title": "AcceleratorTypes wait Sample", + "origin": "API_DEFINITION", + "description": " Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", + "canonical": true, + "file": "region_operations.wait.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Wait", + "fullName": "google.cloud.compute.v1.RegionOperations.Wait", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionOperationsClient", + "fullName": "google.cloud.compute.v1.RegionOperationsClient" + }, + "method": { + "shortName": "Wait", + "fullName": "google.cloud.compute.v1.RegionOperations.Wait", + "service": { + "shortName": "RegionOperations", + "fullName": "google.cloud.compute.v1.RegionOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Regions_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", + "canonical": true, + "file": "regions.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Regions.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Region", + "client": { + "shortName": "RegionsClient", + "fullName": "google.cloud.compute.v1.RegionsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Regions.Get", + "service": { + "shortName": "Regions", + "fullName": "google.cloud.compute.v1.Regions" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Regions_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", + "canonical": true, + "file": "regions.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Regions.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RegionList", + "client": { + "shortName": "RegionsClient", + "fullName": "google.cloud.compute.v1.RegionsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Regions.List", + "service": { + "shortName": "Regions", + "fullName": "google.cloud.compute.v1.Regions" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSecurityPolicies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified policy.", + "canonical": true, + "file": "region_security_policies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "security_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionSecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionSecurityPoliciesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies.Delete", + "service": { + "shortName": "RegionSecurityPolicies", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSecurityPolicies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " List all of the ordered rules present in a single specified policy.", + "canonical": true, + "file": "region_security_policies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "security_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.SecurityPolicy", + "client": { + "shortName": "RegionSecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionSecurityPoliciesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies.Get", + "service": { + "shortName": "RegionSecurityPolicies", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSecurityPolicies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a new policy in the specified project using the data included in the request.", + "canonical": true, + "file": "region_security_policies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "security_policy_resource", + "type": ".google.cloud.compute.v1.SecurityPolicy" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionSecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionSecurityPoliciesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies.Insert", + "service": { + "shortName": "RegionSecurityPolicies", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSecurityPolicies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " List all the policies that have been configured for the specified project and region.", + "canonical": true, + "file": "region_security_policies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SecurityPolicyList", + "client": { + "shortName": "RegionSecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionSecurityPoliciesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies.List", + "service": { + "shortName": "RegionSecurityPolicies", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSecurityPolicies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + "canonical": true, + "file": "region_security_policies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "security_policy", + "type": "TYPE_STRING" + }, + { + "name": "security_policy_resource", + "type": ".google.cloud.compute.v1.SecurityPolicy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionSecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionSecurityPoliciesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies.Patch", + "service": { + "shortName": "RegionSecurityPolicies", + "fullName": "google.cloud.compute.v1.RegionSecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSslCertificates_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified SslCertificate resource in the region.", + "canonical": true, + "file": "region_ssl_certificates.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionSslCertificates.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_certificate", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionSslCertificatesClient", + "fullName": "google.cloud.compute.v1.RegionSslCertificatesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionSslCertificates.Delete", + "service": { + "shortName": "RegionSslCertificates", + "fullName": "google.cloud.compute.v1.RegionSslCertificates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSslCertificates_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.", + "canonical": true, + "file": "region_ssl_certificates.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionSslCertificates.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "ssl_certificate", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.SslCertificate", + "client": { + "shortName": "RegionSslCertificatesClient", + "fullName": "google.cloud.compute.v1.RegionSslCertificatesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionSslCertificates.Get", + "service": { + "shortName": "RegionSslCertificates", + "fullName": "google.cloud.compute.v1.RegionSslCertificates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSslCertificates_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a SslCertificate resource in the specified project and region using the data included in the request", + "canonical": true, + "file": "region_ssl_certificates.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionSslCertificates.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_certificate_resource", + "type": ".google.cloud.compute.v1.SslCertificate" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionSslCertificatesClient", + "fullName": "google.cloud.compute.v1.RegionSslCertificatesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionSslCertificates.Insert", + "service": { + "shortName": "RegionSslCertificates", + "fullName": "google.cloud.compute.v1.RegionSslCertificates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSslCertificates_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of SslCertificate resources available to the specified project in the specified region.", + "canonical": true, + "file": "region_ssl_certificates.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionSslCertificates.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SslCertificateList", + "client": { + "shortName": "RegionSslCertificatesClient", + "fullName": "google.cloud.compute.v1.RegionSslCertificatesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionSslCertificates.List", + "service": { + "shortName": "RegionSslCertificates", + "fullName": "google.cloud.compute.v1.RegionSslCertificates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSslPolicies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.", + "canonical": true, + "file": "region_ssl_policies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionSslPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionSslPoliciesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.Delete", + "service": { + "shortName": "RegionSslPolicies", + "fullName": "google.cloud.compute.v1.RegionSslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSslPolicies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Lists all of the ordered rules present in a single specified policy.", + "canonical": true, + "file": "region_ssl_policies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.SslPolicy", + "client": { + "shortName": "RegionSslPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionSslPoliciesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.Get", + "service": { + "shortName": "RegionSslPolicies", + "fullName": "google.cloud.compute.v1.RegionSslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSslPolicies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a new policy in the specified project and region using the data included in the request.", + "canonical": true, + "file": "region_ssl_policies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy_resource", + "type": ".google.cloud.compute.v1.SslPolicy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionSslPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionSslPoliciesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.Insert", + "service": { + "shortName": "RegionSslPolicies", + "fullName": "google.cloud.compute.v1.RegionSslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSslPolicies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists all the SSL policies that have been configured for the specified project and region.", + "canonical": true, + "file": "region_ssl_policies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SslPoliciesList", + "client": { + "shortName": "RegionSslPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionSslPoliciesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.List", + "service": { + "shortName": "RegionSslPolicies", + "fullName": "google.cloud.compute.v1.RegionSslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSslPolicies_ListAvailableFeatures_async", + "title": "AcceleratorTypes listAvailableFeatures Sample", + "origin": "API_DEFINITION", + "description": " Lists all features that can be specified in the SSL policy when using custom profile.", + "canonical": true, + "file": "region_ssl_policies.list_available_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAvailableFeatures", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.ListAvailableFeatures", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SslPoliciesListAvailableFeaturesResponse", + "client": { + "shortName": "RegionSslPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionSslPoliciesClient" + }, + "method": { + "shortName": "ListAvailableFeatures", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.ListAvailableFeatures", + "service": { + "shortName": "RegionSslPolicies", + "fullName": "google.cloud.compute.v1.RegionSslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionSslPolicies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified SSL policy with the data included in the request.", + "canonical": true, + "file": "region_ssl_policies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy_resource", + "type": ".google.cloud.compute.v1.SslPolicy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionSslPoliciesClient", + "fullName": "google.cloud.compute.v1.RegionSslPoliciesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionSslPolicies.Patch", + "service": { + "shortName": "RegionSslPolicies", + "fullName": "google.cloud.compute.v1.RegionSslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpProxies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified TargetHttpProxy resource.", + "canonical": true, + "file": "region_target_http_proxies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_http_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionTargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxiesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies.Delete", + "service": { + "shortName": "RegionTargetHttpProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpProxies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified TargetHttpProxy resource in the specified region.", + "canonical": true, + "file": "region_target_http_proxies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "target_http_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetHttpProxy", + "client": { + "shortName": "RegionTargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxiesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies.Get", + "service": { + "shortName": "RegionTargetHttpProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpProxies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.", + "canonical": true, + "file": "region_target_http_proxies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_http_proxy_resource", + "type": ".google.cloud.compute.v1.TargetHttpProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionTargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxiesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies.Insert", + "service": { + "shortName": "RegionTargetHttpProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpProxies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.", + "canonical": true, + "file": "region_target_http_proxies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetHttpProxyList", + "client": { + "shortName": "RegionTargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxiesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies.List", + "service": { + "shortName": "RegionTargetHttpProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpProxies_SetUrlMap_async", + "title": "AcceleratorTypes setUrlMap Sample", + "origin": "API_DEFINITION", + "description": " Changes the URL map for TargetHttpProxy.", + "canonical": true, + "file": "region_target_http_proxies.set_url_map.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetUrlMap", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies.SetUrlMap", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_http_proxy", + "type": "TYPE_STRING" + }, + { + "name": "url_map_reference_resource", + "type": ".google.cloud.compute.v1.UrlMapReference" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionTargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxiesClient" + }, + "method": { + "shortName": "SetUrlMap", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies.SetUrlMap", + "service": { + "shortName": "RegionTargetHttpProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpsProxies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified TargetHttpsProxy resource.", + "canonical": true, + "file": "region_target_https_proxies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionTargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxiesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.Delete", + "service": { + "shortName": "RegionTargetHttpsProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpsProxies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified TargetHttpsProxy resource in the specified region.", + "canonical": true, + "file": "region_target_https_proxies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetHttpsProxy", + "client": { + "shortName": "RegionTargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxiesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.Get", + "service": { + "shortName": "RegionTargetHttpsProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpsProxies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.", + "canonical": true, + "file": "region_target_https_proxies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy_resource", + "type": ".google.cloud.compute.v1.TargetHttpsProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionTargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxiesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.Insert", + "service": { + "shortName": "RegionTargetHttpsProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpsProxies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.", + "canonical": true, + "file": "region_target_https_proxies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetHttpsProxyList", + "client": { + "shortName": "RegionTargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxiesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.List", + "service": { + "shortName": "RegionTargetHttpsProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpsProxies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "canonical": true, + "file": "region_target_https_proxies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy_resource", + "type": ".google.cloud.compute.v1.TargetHttpsProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionTargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxiesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.Patch", + "service": { + "shortName": "RegionTargetHttpsProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpsProxies_SetSslCertificates_async", + "title": "AcceleratorTypes setSslCertificates Sample", + "origin": "API_DEFINITION", + "description": " Replaces SslCertificates for TargetHttpsProxy.", + "canonical": true, + "file": "region_target_https_proxies.set_ssl_certificates.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetSslCertificates", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.SetSslCertificates", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_target_https_proxies_set_ssl_certificates_request_resource", + "type": ".google.cloud.compute.v1.RegionTargetHttpsProxiesSetSslCertificatesRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionTargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxiesClient" + }, + "method": { + "shortName": "SetSslCertificates", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.SetSslCertificates", + "service": { + "shortName": "RegionTargetHttpsProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetHttpsProxies_SetUrlMap_async", + "title": "AcceleratorTypes setUrlMap Sample", + "origin": "API_DEFINITION", + "description": " Changes the URL map for TargetHttpsProxy.", + "canonical": true, + "file": "region_target_https_proxies.set_url_map.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetUrlMap", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.SetUrlMap", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + }, + { + "name": "url_map_reference_resource", + "type": ".google.cloud.compute.v1.UrlMapReference" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionTargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxiesClient" + }, + "method": { + "shortName": "SetUrlMap", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies.SetUrlMap", + "service": { + "shortName": "RegionTargetHttpsProxies", + "fullName": "google.cloud.compute.v1.RegionTargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetTcpProxies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified TargetTcpProxy resource.", + "canonical": true, + "file": "region_target_tcp_proxies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_tcp_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionTargetTcpProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxiesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies.Delete", + "service": { + "shortName": "RegionTargetTcpProxies", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetTcpProxies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified TargetTcpProxy resource.", + "canonical": true, + "file": "region_target_tcp_proxies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "target_tcp_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetTcpProxy", + "client": { + "shortName": "RegionTargetTcpProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxiesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies.Get", + "service": { + "shortName": "RegionTargetTcpProxies", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetTcpProxies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.", + "canonical": true, + "file": "region_target_tcp_proxies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_tcp_proxy_resource", + "type": ".google.cloud.compute.v1.TargetTcpProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionTargetTcpProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxiesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies.Insert", + "service": { + "shortName": "RegionTargetTcpProxies", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionTargetTcpProxies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.", + "canonical": true, + "file": "region_target_tcp_proxies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetTcpProxyList", + "client": { + "shortName": "RegionTargetTcpProxiesClient", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxiesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies.List", + "service": { + "shortName": "RegionTargetTcpProxies", + "fullName": "google.cloud.compute.v1.RegionTargetTcpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionUrlMaps_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified UrlMap resource.", + "canonical": true, + "file": "region_url_maps.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "url_map", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionUrlMapsClient", + "fullName": "google.cloud.compute.v1.RegionUrlMapsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Delete", + "service": { + "shortName": "RegionUrlMaps", + "fullName": "google.cloud.compute.v1.RegionUrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionUrlMaps_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified UrlMap resource.", + "canonical": true, + "file": "region_url_maps.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "url_map", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.UrlMap", + "client": { + "shortName": "RegionUrlMapsClient", + "fullName": "google.cloud.compute.v1.RegionUrlMapsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Get", + "service": { + "shortName": "RegionUrlMaps", + "fullName": "google.cloud.compute.v1.RegionUrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionUrlMaps_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a UrlMap resource in the specified project using the data included in the request.", + "canonical": true, + "file": "region_url_maps.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "url_map_resource", + "type": ".google.cloud.compute.v1.UrlMap" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionUrlMapsClient", + "fullName": "google.cloud.compute.v1.RegionUrlMapsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Insert", + "service": { + "shortName": "RegionUrlMaps", + "fullName": "google.cloud.compute.v1.RegionUrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionUrlMaps_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of UrlMap resources available to the specified project in the specified region.", + "canonical": true, + "file": "region_url_maps.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.UrlMapList", + "client": { + "shortName": "RegionUrlMapsClient", + "fullName": "google.cloud.compute.v1.RegionUrlMapsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.List", + "service": { + "shortName": "RegionUrlMaps", + "fullName": "google.cloud.compute.v1.RegionUrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionUrlMaps_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "canonical": true, + "file": "region_url_maps.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "url_map", + "type": "TYPE_STRING" + }, + { + "name": "url_map_resource", + "type": ".google.cloud.compute.v1.UrlMap" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionUrlMapsClient", + "fullName": "google.cloud.compute.v1.RegionUrlMapsClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Patch", + "service": { + "shortName": "RegionUrlMaps", + "fullName": "google.cloud.compute.v1.RegionUrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionUrlMaps_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified UrlMap resource with the data included in the request.", + "canonical": true, + "file": "region_url_maps.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Update", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "url_map", + "type": "TYPE_STRING" + }, + { + "name": "url_map_resource", + "type": ".google.cloud.compute.v1.UrlMap" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RegionUrlMapsClient", + "fullName": "google.cloud.compute.v1.RegionUrlMapsClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Update", + "service": { + "shortName": "RegionUrlMaps", + "fullName": "google.cloud.compute.v1.RegionUrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_RegionUrlMaps_Validate_async", + "title": "AcceleratorTypes validate Sample", + "origin": "API_DEFINITION", + "description": " Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.", + "canonical": true, + "file": "region_url_maps.validate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Validate", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Validate", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_url_maps_validate_request_resource", + "type": ".google.cloud.compute.v1.RegionUrlMapsValidateRequest" + }, + { + "name": "url_map", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.UrlMapsValidateResponse", + "client": { + "shortName": "RegionUrlMapsClient", + "fullName": "google.cloud.compute.v1.RegionUrlMapsClient" + }, + "method": { + "shortName": "Validate", + "fullName": "google.cloud.compute.v1.RegionUrlMaps.Validate", + "service": { + "shortName": "RegionUrlMaps", + "fullName": "google.cloud.compute.v1.RegionUrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Reservations_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of reservations.", + "canonical": true, + "file": "reservations.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Reservations.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ReservationAggregatedList", + "client": { + "shortName": "ReservationsClient", + "fullName": "google.cloud.compute.v1.ReservationsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Reservations.AggregatedList", + "service": { + "shortName": "Reservations", + "fullName": "google.cloud.compute.v1.Reservations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Reservations_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified reservation.", + "canonical": true, + "file": "reservations.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Reservations.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "reservation", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ReservationsClient", + "fullName": "google.cloud.compute.v1.ReservationsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Reservations.Delete", + "service": { + "shortName": "Reservations", + "fullName": "google.cloud.compute.v1.Reservations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Reservations_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Retrieves information about the specified reservation.", + "canonical": true, + "file": "reservations.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Reservations.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "reservation", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Reservation", + "client": { + "shortName": "ReservationsClient", + "fullName": "google.cloud.compute.v1.ReservationsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Reservations.Get", + "service": { + "shortName": "Reservations", + "fullName": "google.cloud.compute.v1.Reservations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Reservations_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "reservations.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Reservations.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "ReservationsClient", + "fullName": "google.cloud.compute.v1.ReservationsClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Reservations.GetIamPolicy", + "service": { + "shortName": "Reservations", + "fullName": "google.cloud.compute.v1.Reservations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Reservations_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a new reservation. For more information, read Reserving zonal resources.", + "canonical": true, + "file": "reservations.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Reservations.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "reservation_resource", + "type": ".google.cloud.compute.v1.Reservation" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ReservationsClient", + "fullName": "google.cloud.compute.v1.ReservationsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Reservations.Insert", + "service": { + "shortName": "Reservations", + "fullName": "google.cloud.compute.v1.Reservations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Reservations_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " A list of all the reservations that have been configured for the specified project in specified zone.", + "canonical": true, + "file": "reservations.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Reservations.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.ReservationList", + "client": { + "shortName": "ReservationsClient", + "fullName": "google.cloud.compute.v1.ReservationsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Reservations.List", + "service": { + "shortName": "Reservations", + "fullName": "google.cloud.compute.v1.Reservations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Reservations_Resize_async", + "title": "AcceleratorTypes resize Sample", + "origin": "API_DEFINITION", + "description": " Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.", + "canonical": true, + "file": "reservations.resize.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Resize", + "fullName": "google.cloud.compute.v1.Reservations.Resize", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "reservation", + "type": "TYPE_STRING" + }, + { + "name": "reservations_resize_request_resource", + "type": ".google.cloud.compute.v1.ReservationsResizeRequest" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ReservationsClient", + "fullName": "google.cloud.compute.v1.ReservationsClient" + }, + "method": { + "shortName": "Resize", + "fullName": "google.cloud.compute.v1.Reservations.Resize", + "service": { + "shortName": "Reservations", + "fullName": "google.cloud.compute.v1.Reservations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Reservations_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "reservations.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Reservations.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + }, + { + "name": "zone_set_policy_request_resource", + "type": ".google.cloud.compute.v1.ZoneSetPolicyRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "ReservationsClient", + "fullName": "google.cloud.compute.v1.ReservationsClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Reservations.SetIamPolicy", + "service": { + "shortName": "Reservations", + "fullName": "google.cloud.compute.v1.Reservations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Reservations_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "reservations.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Reservations.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "ReservationsClient", + "fullName": "google.cloud.compute.v1.ReservationsClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Reservations.TestIamPermissions", + "service": { + "shortName": "Reservations", + "fullName": "google.cloud.compute.v1.Reservations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Reservations_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Update share settings of the reservation.", + "canonical": true, + "file": "reservations.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Reservations.Update", + "async": true, + "parameters": [ + { + "name": "paths", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "reservation", + "type": "TYPE_STRING" + }, + { + "name": "reservation_resource", + "type": ".google.cloud.compute.v1.Reservation" + }, + { + "name": "update_mask", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ReservationsClient", + "fullName": "google.cloud.compute.v1.ReservationsClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Reservations.Update", + "service": { + "shortName": "Reservations", + "fullName": "google.cloud.compute.v1.Reservations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ResourcePolicies_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of resource policies.", + "canonical": true, + "file": "resource_policies.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.ResourcePolicies.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ResourcePolicyAggregatedList", + "client": { + "shortName": "ResourcePoliciesClient", + "fullName": "google.cloud.compute.v1.ResourcePoliciesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.ResourcePolicies.AggregatedList", + "service": { + "shortName": "ResourcePolicies", + "fullName": "google.cloud.compute.v1.ResourcePolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ResourcePolicies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified resource policy.", + "canonical": true, + "file": "resource_policies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.ResourcePolicies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ResourcePoliciesClient", + "fullName": "google.cloud.compute.v1.ResourcePoliciesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.ResourcePolicies.Delete", + "service": { + "shortName": "ResourcePolicies", + "fullName": "google.cloud.compute.v1.ResourcePolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ResourcePolicies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Retrieves all information of the specified resource policy.", + "canonical": true, + "file": "resource_policies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ResourcePolicies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.ResourcePolicy", + "client": { + "shortName": "ResourcePoliciesClient", + "fullName": "google.cloud.compute.v1.ResourcePoliciesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ResourcePolicies.Get", + "service": { + "shortName": "ResourcePolicies", + "fullName": "google.cloud.compute.v1.ResourcePolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ResourcePolicies_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "resource_policies.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.ResourcePolicies.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "ResourcePoliciesClient", + "fullName": "google.cloud.compute.v1.ResourcePoliciesClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.ResourcePolicies.GetIamPolicy", + "service": { + "shortName": "ResourcePolicies", + "fullName": "google.cloud.compute.v1.ResourcePolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ResourcePolicies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a new resource policy.", + "canonical": true, + "file": "resource_policies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.ResourcePolicies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource_policy_resource", + "type": ".google.cloud.compute.v1.ResourcePolicy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ResourcePoliciesClient", + "fullName": "google.cloud.compute.v1.ResourcePoliciesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.ResourcePolicies.Insert", + "service": { + "shortName": "ResourcePolicies", + "fullName": "google.cloud.compute.v1.ResourcePolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ResourcePolicies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " A list all the resource policies that have been configured for the specified project in specified region.", + "canonical": true, + "file": "resource_policies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.ResourcePolicies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ResourcePolicyList", + "client": { + "shortName": "ResourcePoliciesClient", + "fullName": "google.cloud.compute.v1.ResourcePoliciesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.ResourcePolicies.List", + "service": { + "shortName": "ResourcePolicies", + "fullName": "google.cloud.compute.v1.ResourcePolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ResourcePolicies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Modify the specified resource policy.", + "canonical": true, + "file": "resource_policies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.ResourcePolicies.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource_policy", + "type": "TYPE_STRING" + }, + { + "name": "resource_policy_resource", + "type": ".google.cloud.compute.v1.ResourcePolicy" + }, + { + "name": "update_mask", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ResourcePoliciesClient", + "fullName": "google.cloud.compute.v1.ResourcePoliciesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.ResourcePolicies.Patch", + "service": { + "shortName": "ResourcePolicies", + "fullName": "google.cloud.compute.v1.ResourcePolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ResourcePolicies_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "resource_policies.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.ResourcePolicies.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_policy_request_resource", + "type": ".google.cloud.compute.v1.RegionSetPolicyRequest" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "ResourcePoliciesClient", + "fullName": "google.cloud.compute.v1.ResourcePoliciesClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.ResourcePolicies.SetIamPolicy", + "service": { + "shortName": "ResourcePolicies", + "fullName": "google.cloud.compute.v1.ResourcePolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ResourcePolicies_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "resource_policies.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.ResourcePolicies.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "ResourcePoliciesClient", + "fullName": "google.cloud.compute.v1.ResourcePoliciesClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.ResourcePolicies.TestIamPermissions", + "service": { + "shortName": "ResourcePolicies", + "fullName": "google.cloud.compute.v1.ResourcePolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routers_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of routers.", + "canonical": true, + "file": "routers.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Routers.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RouterAggregatedList", + "client": { + "shortName": "RoutersClient", + "fullName": "google.cloud.compute.v1.RoutersClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Routers.AggregatedList", + "service": { + "shortName": "Routers", + "fullName": "google.cloud.compute.v1.Routers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routers_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified Router resource.", + "canonical": true, + "file": "routers.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Routers.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "router", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RoutersClient", + "fullName": "google.cloud.compute.v1.RoutersClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Routers.Delete", + "service": { + "shortName": "Routers", + "fullName": "google.cloud.compute.v1.Routers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routers_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified Router resource.", + "canonical": true, + "file": "routers.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Routers.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "router", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Router", + "client": { + "shortName": "RoutersClient", + "fullName": "google.cloud.compute.v1.RoutersClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Routers.Get", + "service": { + "shortName": "Routers", + "fullName": "google.cloud.compute.v1.Routers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routers_GetNatMappingInfo_async", + "title": "AcceleratorTypes getNatMappingInfo Sample", + "origin": "API_DEFINITION", + "description": " Retrieves runtime Nat mapping information of VM endpoints.", + "canonical": true, + "file": "routers.get_nat_mapping_info.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 89, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetNatMappingInfo", + "fullName": "google.cloud.compute.v1.Routers.GetNatMappingInfo", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "nat_name", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "router", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.VmEndpointNatMappingsList", + "client": { + "shortName": "RoutersClient", + "fullName": "google.cloud.compute.v1.RoutersClient" + }, + "method": { + "shortName": "GetNatMappingInfo", + "fullName": "google.cloud.compute.v1.Routers.GetNatMappingInfo", + "service": { + "shortName": "Routers", + "fullName": "google.cloud.compute.v1.Routers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routers_GetRouterStatus_async", + "title": "AcceleratorTypes getRouterStatus Sample", + "origin": "API_DEFINITION", + "description": " Retrieves runtime information of the specified router.", + "canonical": true, + "file": "routers.get_router_status.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetRouterStatus", + "fullName": "google.cloud.compute.v1.Routers.GetRouterStatus", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "router", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.RouterStatusResponse", + "client": { + "shortName": "RoutersClient", + "fullName": "google.cloud.compute.v1.RoutersClient" + }, + "method": { + "shortName": "GetRouterStatus", + "fullName": "google.cloud.compute.v1.Routers.GetRouterStatus", + "service": { + "shortName": "Routers", + "fullName": "google.cloud.compute.v1.Routers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routers_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a Router resource in the specified project and region using the data included in the request.", + "canonical": true, + "file": "routers.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Routers.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "router_resource", + "type": ".google.cloud.compute.v1.Router" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RoutersClient", + "fullName": "google.cloud.compute.v1.RoutersClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Routers.Insert", + "service": { + "shortName": "Routers", + "fullName": "google.cloud.compute.v1.Routers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routers_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of Router resources available to the specified project.", + "canonical": true, + "file": "routers.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Routers.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RouterList", + "client": { + "shortName": "RoutersClient", + "fullName": "google.cloud.compute.v1.RoutersClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Routers.List", + "service": { + "shortName": "Routers", + "fullName": "google.cloud.compute.v1.Routers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routers_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "canonical": true, + "file": "routers.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Routers.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "router", + "type": "TYPE_STRING" + }, + { + "name": "router_resource", + "type": ".google.cloud.compute.v1.Router" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RoutersClient", + "fullName": "google.cloud.compute.v1.RoutersClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Routers.Patch", + "service": { + "shortName": "Routers", + "fullName": "google.cloud.compute.v1.Routers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routers_Preview_async", + "title": "AcceleratorTypes preview Sample", + "origin": "API_DEFINITION", + "description": " Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.", + "canonical": true, + "file": "routers.preview.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Preview", + "fullName": "google.cloud.compute.v1.Routers.Preview", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "router", + "type": "TYPE_STRING" + }, + { + "name": "router_resource", + "type": ".google.cloud.compute.v1.Router" + } + ], + "resultType": ".google.cloud.compute.v1.RoutersPreviewResponse", + "client": { + "shortName": "RoutersClient", + "fullName": "google.cloud.compute.v1.RoutersClient" + }, + "method": { + "shortName": "Preview", + "fullName": "google.cloud.compute.v1.Routers.Preview", + "service": { + "shortName": "Routers", + "fullName": "google.cloud.compute.v1.Routers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routers_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.", + "canonical": true, + "file": "routers.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Routers.Update", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "router", + "type": "TYPE_STRING" + }, + { + "name": "router_resource", + "type": ".google.cloud.compute.v1.Router" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RoutersClient", + "fullName": "google.cloud.compute.v1.RoutersClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.Routers.Update", + "service": { + "shortName": "Routers", + "fullName": "google.cloud.compute.v1.Routers" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routes_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified Route resource.", + "canonical": true, + "file": "routes.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Routes.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "route", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RoutesClient", + "fullName": "google.cloud.compute.v1.RoutesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Routes.Delete", + "service": { + "shortName": "Routes", + "fullName": "google.cloud.compute.v1.Routes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routes_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified Route resource.", + "canonical": true, + "file": "routes.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Routes.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "route", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Route", + "client": { + "shortName": "RoutesClient", + "fullName": "google.cloud.compute.v1.RoutesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Routes.Get", + "service": { + "shortName": "Routes", + "fullName": "google.cloud.compute.v1.Routes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routes_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a Route resource in the specified project using the data included in the request.", + "canonical": true, + "file": "routes.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Routes.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "route_resource", + "type": ".google.cloud.compute.v1.Route" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "RoutesClient", + "fullName": "google.cloud.compute.v1.RoutesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Routes.Insert", + "service": { + "shortName": "Routes", + "fullName": "google.cloud.compute.v1.Routes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Routes_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of Route resources available to the specified project.", + "canonical": true, + "file": "routes.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Routes.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.RouteList", + "client": { + "shortName": "RoutesClient", + "fullName": "google.cloud.compute.v1.RoutesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Routes.List", + "service": { + "shortName": "Routes", + "fullName": "google.cloud.compute.v1.Routes" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_AddRule_async", + "title": "AcceleratorTypes addRule Sample", + "origin": "API_DEFINITION", + "description": " Inserts a rule into a security policy.", + "canonical": true, + "file": "security_policies.add_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddRule", + "fullName": "google.cloud.compute.v1.SecurityPolicies.AddRule", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "security_policy", + "type": "TYPE_STRING" + }, + { + "name": "security_policy_rule_resource", + "type": ".google.cloud.compute.v1.SecurityPolicyRule" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "AddRule", + "fullName": "google.cloud.compute.v1.SecurityPolicies.AddRule", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.", + "canonical": true, + "file": "security_policies.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.SecurityPolicies.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SecurityPoliciesAggregatedList", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.SecurityPolicies.AggregatedList", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified policy.", + "canonical": true, + "file": "security_policies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.SecurityPolicies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "security_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.SecurityPolicies.Delete", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " List all of the ordered rules present in a single specified policy.", + "canonical": true, + "file": "security_policies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.SecurityPolicies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "security_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.SecurityPolicy", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.SecurityPolicies.Get", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_GetRule_async", + "title": "AcceleratorTypes getRule Sample", + "origin": "API_DEFINITION", + "description": " Gets a rule at the specified priority.", + "canonical": true, + "file": "security_policies.get_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetRule", + "fullName": "google.cloud.compute.v1.SecurityPolicies.GetRule", + "async": true, + "parameters": [ + { + "name": "priority", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "security_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.SecurityPolicyRule", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "GetRule", + "fullName": "google.cloud.compute.v1.SecurityPolicies.GetRule", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a new policy in the specified project using the data included in the request.", + "canonical": true, + "file": "security_policies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.SecurityPolicies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "security_policy_resource", + "type": ".google.cloud.compute.v1.SecurityPolicy" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.SecurityPolicies.Insert", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " List all the policies that have been configured for the specified project.", + "canonical": true, + "file": "security_policies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.SecurityPolicies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SecurityPolicyList", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.SecurityPolicies.List", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_ListPreconfiguredExpressionSets_async", + "title": "AcceleratorTypes listPreconfiguredExpressionSets Sample", + "origin": "API_DEFINITION", + "description": " Gets the current list of preconfigured Web Application Firewall (WAF) expressions.", + "canonical": true, + "file": "security_policies.list_preconfigured_expression_sets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPreconfiguredExpressionSets", + "fullName": "google.cloud.compute.v1.SecurityPolicies.ListPreconfiguredExpressionSets", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SecurityPoliciesListPreconfiguredExpressionSetsResponse", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "ListPreconfiguredExpressionSets", + "fullName": "google.cloud.compute.v1.SecurityPolicies.ListPreconfiguredExpressionSets", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", + "canonical": true, + "file": "security_policies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.SecurityPolicies.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "security_policy", + "type": "TYPE_STRING" + }, + { + "name": "security_policy_resource", + "type": ".google.cloud.compute.v1.SecurityPolicy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.SecurityPolicies.Patch", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_PatchRule_async", + "title": "AcceleratorTypes patchRule Sample", + "origin": "API_DEFINITION", + "description": " Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", + "canonical": true, + "file": "security_policies.patch_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PatchRule", + "fullName": "google.cloud.compute.v1.SecurityPolicies.PatchRule", + "async": true, + "parameters": [ + { + "name": "priority", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "security_policy", + "type": "TYPE_STRING" + }, + { + "name": "security_policy_rule_resource", + "type": ".google.cloud.compute.v1.SecurityPolicyRule" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "PatchRule", + "fullName": "google.cloud.compute.v1.SecurityPolicies.PatchRule", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_RemoveRule_async", + "title": "AcceleratorTypes removeRule Sample", + "origin": "API_DEFINITION", + "description": " Deletes a rule at the specified priority.", + "canonical": true, + "file": "security_policies.remove_rule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveRule", + "fullName": "google.cloud.compute.v1.SecurityPolicies.RemoveRule", + "async": true, + "parameters": [ + { + "name": "priority", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "security_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "RemoveRule", + "fullName": "google.cloud.compute.v1.SecurityPolicies.RemoveRule", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SecurityPolicies_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "security_policies.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.SecurityPolicies.SetLabels", + "async": true, + "parameters": [ + { + "name": "global_set_labels_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetLabelsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SecurityPoliciesClient", + "fullName": "google.cloud.compute.v1.SecurityPoliciesClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.SecurityPolicies.SetLabels", + "service": { + "shortName": "SecurityPolicies", + "fullName": "google.cloud.compute.v1.SecurityPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ServiceAttachments_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.", + "canonical": true, + "file": "service_attachments.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.ServiceAttachments.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ServiceAttachmentAggregatedList", + "client": { + "shortName": "ServiceAttachmentsClient", + "fullName": "google.cloud.compute.v1.ServiceAttachmentsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.ServiceAttachments.AggregatedList", + "service": { + "shortName": "ServiceAttachments", + "fullName": "google.cloud.compute.v1.ServiceAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ServiceAttachments_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified ServiceAttachment in the given scope", + "canonical": true, + "file": "service_attachments.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.ServiceAttachments.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "service_attachment", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ServiceAttachmentsClient", + "fullName": "google.cloud.compute.v1.ServiceAttachmentsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.ServiceAttachments.Delete", + "service": { + "shortName": "ServiceAttachments", + "fullName": "google.cloud.compute.v1.ServiceAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ServiceAttachments_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified ServiceAttachment resource in the given scope.", + "canonical": true, + "file": "service_attachments.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ServiceAttachments.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "service_attachment", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.ServiceAttachment", + "client": { + "shortName": "ServiceAttachmentsClient", + "fullName": "google.cloud.compute.v1.ServiceAttachmentsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ServiceAttachments.Get", + "service": { + "shortName": "ServiceAttachments", + "fullName": "google.cloud.compute.v1.ServiceAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ServiceAttachments_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "service_attachments.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.ServiceAttachments.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "ServiceAttachmentsClient", + "fullName": "google.cloud.compute.v1.ServiceAttachmentsClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.ServiceAttachments.GetIamPolicy", + "service": { + "shortName": "ServiceAttachments", + "fullName": "google.cloud.compute.v1.ServiceAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ServiceAttachments_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.", + "canonical": true, + "file": "service_attachments.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.ServiceAttachments.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "service_attachment_resource", + "type": ".google.cloud.compute.v1.ServiceAttachment" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ServiceAttachmentsClient", + "fullName": "google.cloud.compute.v1.ServiceAttachmentsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.ServiceAttachments.Insert", + "service": { + "shortName": "ServiceAttachments", + "fullName": "google.cloud.compute.v1.ServiceAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ServiceAttachments_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists the ServiceAttachments for a project in the given scope.", + "canonical": true, + "file": "service_attachments.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.ServiceAttachments.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ServiceAttachmentList", + "client": { + "shortName": "ServiceAttachmentsClient", + "fullName": "google.cloud.compute.v1.ServiceAttachmentsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.ServiceAttachments.List", + "service": { + "shortName": "ServiceAttachments", + "fullName": "google.cloud.compute.v1.ServiceAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ServiceAttachments_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "canonical": true, + "file": "service_attachments.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.ServiceAttachments.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "service_attachment", + "type": "TYPE_STRING" + }, + { + "name": "service_attachment_resource", + "type": ".google.cloud.compute.v1.ServiceAttachment" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ServiceAttachmentsClient", + "fullName": "google.cloud.compute.v1.ServiceAttachmentsClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.ServiceAttachments.Patch", + "service": { + "shortName": "ServiceAttachments", + "fullName": "google.cloud.compute.v1.ServiceAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ServiceAttachments_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "service_attachments.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.ServiceAttachments.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_policy_request_resource", + "type": ".google.cloud.compute.v1.RegionSetPolicyRequest" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "ServiceAttachmentsClient", + "fullName": "google.cloud.compute.v1.ServiceAttachmentsClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.ServiceAttachments.SetIamPolicy", + "service": { + "shortName": "ServiceAttachments", + "fullName": "google.cloud.compute.v1.ServiceAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ServiceAttachments_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "service_attachments.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.ServiceAttachments.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "ServiceAttachmentsClient", + "fullName": "google.cloud.compute.v1.ServiceAttachmentsClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.ServiceAttachments.TestIamPermissions", + "service": { + "shortName": "ServiceAttachments", + "fullName": "google.cloud.compute.v1.ServiceAttachments" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Snapshots_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.", + "canonical": true, + "file": "snapshots.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Snapshots.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "snapshot", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SnapshotsClient", + "fullName": "google.cloud.compute.v1.SnapshotsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Snapshots.Delete", + "service": { + "shortName": "Snapshots", + "fullName": "google.cloud.compute.v1.Snapshots" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Snapshots_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified Snapshot resource.", + "canonical": true, + "file": "snapshots.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Snapshots.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "snapshot", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Snapshot", + "client": { + "shortName": "SnapshotsClient", + "fullName": "google.cloud.compute.v1.SnapshotsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Snapshots.Get", + "service": { + "shortName": "Snapshots", + "fullName": "google.cloud.compute.v1.Snapshots" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Snapshots_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "snapshots.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Snapshots.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "SnapshotsClient", + "fullName": "google.cloud.compute.v1.SnapshotsClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Snapshots.GetIamPolicy", + "service": { + "shortName": "Snapshots", + "fullName": "google.cloud.compute.v1.Snapshots" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Snapshots_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.", + "canonical": true, + "file": "snapshots.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Snapshots.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "snapshot_resource", + "type": ".google.cloud.compute.v1.Snapshot" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SnapshotsClient", + "fullName": "google.cloud.compute.v1.SnapshotsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Snapshots.Insert", + "service": { + "shortName": "Snapshots", + "fullName": "google.cloud.compute.v1.Snapshots" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Snapshots_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of Snapshot resources contained within the specified project.", + "canonical": true, + "file": "snapshots.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Snapshots.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SnapshotList", + "client": { + "shortName": "SnapshotsClient", + "fullName": "google.cloud.compute.v1.SnapshotsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Snapshots.List", + "service": { + "shortName": "Snapshots", + "fullName": "google.cloud.compute.v1.Snapshots" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Snapshots_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "snapshots.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Snapshots.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "global_set_policy_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetPolicyRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "SnapshotsClient", + "fullName": "google.cloud.compute.v1.SnapshotsClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Snapshots.SetIamPolicy", + "service": { + "shortName": "Snapshots", + "fullName": "google.cloud.compute.v1.Snapshots" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Snapshots_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "snapshots.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Snapshots.SetLabels", + "async": true, + "parameters": [ + { + "name": "global_set_labels_request_resource", + "type": ".google.cloud.compute.v1.GlobalSetLabelsRequest" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SnapshotsClient", + "fullName": "google.cloud.compute.v1.SnapshotsClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.Snapshots.SetLabels", + "service": { + "shortName": "Snapshots", + "fullName": "google.cloud.compute.v1.Snapshots" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Snapshots_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "snapshots.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Snapshots.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "SnapshotsClient", + "fullName": "google.cloud.compute.v1.SnapshotsClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Snapshots.TestIamPermissions", + "service": { + "shortName": "Snapshots", + "fullName": "google.cloud.compute.v1.Snapshots" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslCertificates_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.", + "canonical": true, + "file": "ssl_certificates.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.SslCertificates.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SslCertificateAggregatedList", + "client": { + "shortName": "SslCertificatesClient", + "fullName": "google.cloud.compute.v1.SslCertificatesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.SslCertificates.AggregatedList", + "service": { + "shortName": "SslCertificates", + "fullName": "google.cloud.compute.v1.SslCertificates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslCertificates_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified SslCertificate resource.", + "canonical": true, + "file": "ssl_certificates.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.SslCertificates.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_certificate", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SslCertificatesClient", + "fullName": "google.cloud.compute.v1.SslCertificatesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.SslCertificates.Delete", + "service": { + "shortName": "SslCertificates", + "fullName": "google.cloud.compute.v1.SslCertificates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslCertificates_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified SslCertificate resource.", + "canonical": true, + "file": "ssl_certificates.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.SslCertificates.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "ssl_certificate", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.SslCertificate", + "client": { + "shortName": "SslCertificatesClient", + "fullName": "google.cloud.compute.v1.SslCertificatesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.SslCertificates.Get", + "service": { + "shortName": "SslCertificates", + "fullName": "google.cloud.compute.v1.SslCertificates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslCertificates_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a SslCertificate resource in the specified project using the data included in the request.", + "canonical": true, + "file": "ssl_certificates.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.SslCertificates.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_certificate_resource", + "type": ".google.cloud.compute.v1.SslCertificate" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SslCertificatesClient", + "fullName": "google.cloud.compute.v1.SslCertificatesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.SslCertificates.Insert", + "service": { + "shortName": "SslCertificates", + "fullName": "google.cloud.compute.v1.SslCertificates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslCertificates_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of SslCertificate resources available to the specified project.", + "canonical": true, + "file": "ssl_certificates.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.SslCertificates.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SslCertificateList", + "client": { + "shortName": "SslCertificatesClient", + "fullName": "google.cloud.compute.v1.SslCertificatesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.SslCertificates.List", + "service": { + "shortName": "SslCertificates", + "fullName": "google.cloud.compute.v1.SslCertificates" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslPolicies_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.", + "canonical": true, + "file": "ssl_policies.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.SslPolicies.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SslPoliciesAggregatedList", + "client": { + "shortName": "SslPoliciesClient", + "fullName": "google.cloud.compute.v1.SslPoliciesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.SslPolicies.AggregatedList", + "service": { + "shortName": "SslPolicies", + "fullName": "google.cloud.compute.v1.SslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslPolicies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.", + "canonical": true, + "file": "ssl_policies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.SslPolicies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SslPoliciesClient", + "fullName": "google.cloud.compute.v1.SslPoliciesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.SslPolicies.Delete", + "service": { + "shortName": "SslPolicies", + "fullName": "google.cloud.compute.v1.SslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslPolicies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Lists all of the ordered rules present in a single specified policy.", + "canonical": true, + "file": "ssl_policies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.SslPolicies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.SslPolicy", + "client": { + "shortName": "SslPoliciesClient", + "fullName": "google.cloud.compute.v1.SslPoliciesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.SslPolicies.Get", + "service": { + "shortName": "SslPolicies", + "fullName": "google.cloud.compute.v1.SslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslPolicies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified SSL policy resource.", + "canonical": true, + "file": "ssl_policies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.SslPolicies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy_resource", + "type": ".google.cloud.compute.v1.SslPolicy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SslPoliciesClient", + "fullName": "google.cloud.compute.v1.SslPoliciesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.SslPolicies.Insert", + "service": { + "shortName": "SslPolicies", + "fullName": "google.cloud.compute.v1.SslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslPolicies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists all the SSL policies that have been configured for the specified project.", + "canonical": true, + "file": "ssl_policies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.SslPolicies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SslPoliciesList", + "client": { + "shortName": "SslPoliciesClient", + "fullName": "google.cloud.compute.v1.SslPoliciesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.SslPolicies.List", + "service": { + "shortName": "SslPolicies", + "fullName": "google.cloud.compute.v1.SslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslPolicies_ListAvailableFeatures_async", + "title": "AcceleratorTypes listAvailableFeatures Sample", + "origin": "API_DEFINITION", + "description": " Lists all features that can be specified in the SSL policy when using custom profile.", + "canonical": true, + "file": "ssl_policies.list_available_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAvailableFeatures", + "fullName": "google.cloud.compute.v1.SslPolicies.ListAvailableFeatures", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SslPoliciesListAvailableFeaturesResponse", + "client": { + "shortName": "SslPoliciesClient", + "fullName": "google.cloud.compute.v1.SslPoliciesClient" + }, + "method": { + "shortName": "ListAvailableFeatures", + "fullName": "google.cloud.compute.v1.SslPolicies.ListAvailableFeatures", + "service": { + "shortName": "SslPolicies", + "fullName": "google.cloud.compute.v1.SslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_SslPolicies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified SSL policy with the data included in the request.", + "canonical": true, + "file": "ssl_policies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.SslPolicies.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy_resource", + "type": ".google.cloud.compute.v1.SslPolicy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SslPoliciesClient", + "fullName": "google.cloud.compute.v1.SslPoliciesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.SslPolicies.Patch", + "service": { + "shortName": "SslPolicies", + "fullName": "google.cloud.compute.v1.SslPolicies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of subnetworks.", + "canonical": true, + "file": "subnetworks.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Subnetworks.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SubnetworkAggregatedList", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.Subnetworks.AggregatedList", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified subnetwork.", + "canonical": true, + "file": "subnetworks.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Subnetworks.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "subnetwork", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.Subnetworks.Delete", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_ExpandIpCidrRange_async", + "title": "AcceleratorTypes expandIpCidrRange Sample", + "origin": "API_DEFINITION", + "description": " Expands the IP CIDR range of the subnetwork to a specified value.", + "canonical": true, + "file": "subnetworks.expand_ip_cidr_range.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExpandIpCidrRange", + "fullName": "google.cloud.compute.v1.Subnetworks.ExpandIpCidrRange", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "subnetwork", + "type": "TYPE_STRING" + }, + { + "name": "subnetworks_expand_ip_cidr_range_request_resource", + "type": ".google.cloud.compute.v1.SubnetworksExpandIpCidrRangeRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "ExpandIpCidrRange", + "fullName": "google.cloud.compute.v1.Subnetworks.ExpandIpCidrRange", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified subnetwork.", + "canonical": true, + "file": "subnetworks.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Subnetworks.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "subnetwork", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Subnetwork", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Subnetworks.Get", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_GetIamPolicy_async", + "title": "AcceleratorTypes getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "canonical": true, + "file": "subnetworks.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Subnetworks.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "options_requested_policy_version", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.compute.v1.Subnetworks.GetIamPolicy", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a subnetwork in the specified project using the data included in the request.", + "canonical": true, + "file": "subnetworks.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Subnetworks.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "subnetwork_resource", + "type": ".google.cloud.compute.v1.Subnetwork" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.Subnetworks.Insert", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of subnetworks available to the specified project.", + "canonical": true, + "file": "subnetworks.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Subnetworks.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.SubnetworkList", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Subnetworks.List", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_ListUsable_async", + "title": "AcceleratorTypes listUsable Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of all usable subnetworks in the project.", + "canonical": true, + "file": "subnetworks.list_usable.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListUsable", + "fullName": "google.cloud.compute.v1.Subnetworks.ListUsable", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.UsableSubnetworksAggregatedList", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "ListUsable", + "fullName": "google.cloud.compute.v1.Subnetworks.ListUsable", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.", + "canonical": true, + "file": "subnetworks.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Subnetworks.Patch", + "async": true, + "parameters": [ + { + "name": "drain_timeout_seconds", + "type": "TYPE_INT32" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "subnetwork", + "type": "TYPE_STRING" + }, + { + "name": "subnetwork_resource", + "type": ".google.cloud.compute.v1.Subnetwork" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.Subnetworks.Patch", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_SetIamPolicy_async", + "title": "AcceleratorTypes setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy.", + "canonical": true, + "file": "subnetworks.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Subnetworks.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_policy_request_resource", + "type": ".google.cloud.compute.v1.RegionSetPolicyRequest" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Policy", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.compute.v1.Subnetworks.SetIamPolicy", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_SetPrivateIpGoogleAccess_async", + "title": "AcceleratorTypes setPrivateIpGoogleAccess Sample", + "origin": "API_DEFINITION", + "description": " Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.", + "canonical": true, + "file": "subnetworks.set_private_ip_google_access.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetPrivateIpGoogleAccess", + "fullName": "google.cloud.compute.v1.Subnetworks.SetPrivateIpGoogleAccess", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "subnetwork", + "type": "TYPE_STRING" + }, + { + "name": "subnetworks_set_private_ip_google_access_request_resource", + "type": ".google.cloud.compute.v1.SubnetworksSetPrivateIpGoogleAccessRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "SetPrivateIpGoogleAccess", + "fullName": "google.cloud.compute.v1.Subnetworks.SetPrivateIpGoogleAccess", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Subnetworks_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "subnetworks.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Subnetworks.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "SubnetworksClient", + "fullName": "google.cloud.compute.v1.SubnetworksClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.Subnetworks.TestIamPermissions", + "service": { + "shortName": "Subnetworks", + "fullName": "google.cloud.compute.v1.Subnetworks" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetGrpcProxies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified TargetGrpcProxy in the given scope", + "canonical": true, + "file": "target_grpc_proxies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_grpc_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetGrpcProxiesClient", + "fullName": "google.cloud.compute.v1.TargetGrpcProxiesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies.Delete", + "service": { + "shortName": "TargetGrpcProxies", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetGrpcProxies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified TargetGrpcProxy resource in the given scope.", + "canonical": true, + "file": "target_grpc_proxies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "target_grpc_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetGrpcProxy", + "client": { + "shortName": "TargetGrpcProxiesClient", + "fullName": "google.cloud.compute.v1.TargetGrpcProxiesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies.Get", + "service": { + "shortName": "TargetGrpcProxies", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetGrpcProxies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.", + "canonical": true, + "file": "target_grpc_proxies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_grpc_proxy_resource", + "type": ".google.cloud.compute.v1.TargetGrpcProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetGrpcProxiesClient", + "fullName": "google.cloud.compute.v1.TargetGrpcProxiesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies.Insert", + "service": { + "shortName": "TargetGrpcProxies", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetGrpcProxies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Lists the TargetGrpcProxies for a project in the given scope.", + "canonical": true, + "file": "target_grpc_proxies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetGrpcProxyList", + "client": { + "shortName": "TargetGrpcProxiesClient", + "fullName": "google.cloud.compute.v1.TargetGrpcProxiesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies.List", + "service": { + "shortName": "TargetGrpcProxies", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetGrpcProxies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "canonical": true, + "file": "target_grpc_proxies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_grpc_proxy", + "type": "TYPE_STRING" + }, + { + "name": "target_grpc_proxy_resource", + "type": ".google.cloud.compute.v1.TargetGrpcProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetGrpcProxiesClient", + "fullName": "google.cloud.compute.v1.TargetGrpcProxiesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies.Patch", + "service": { + "shortName": "TargetGrpcProxies", + "fullName": "google.cloud.compute.v1.TargetGrpcProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpProxies_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.", + "canonical": true, + "file": "target_http_proxies.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetHttpProxyAggregatedList", + "client": { + "shortName": "TargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpProxiesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.AggregatedList", + "service": { + "shortName": "TargetHttpProxies", + "fullName": "google.cloud.compute.v1.TargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpProxies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified TargetHttpProxy resource.", + "canonical": true, + "file": "target_http_proxies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_http_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpProxiesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.Delete", + "service": { + "shortName": "TargetHttpProxies", + "fullName": "google.cloud.compute.v1.TargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpProxies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified TargetHttpProxy resource.", + "canonical": true, + "file": "target_http_proxies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "target_http_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetHttpProxy", + "client": { + "shortName": "TargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpProxiesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.Get", + "service": { + "shortName": "TargetHttpProxies", + "fullName": "google.cloud.compute.v1.TargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpProxies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a TargetHttpProxy resource in the specified project using the data included in the request.", + "canonical": true, + "file": "target_http_proxies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_http_proxy_resource", + "type": ".google.cloud.compute.v1.TargetHttpProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpProxiesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.Insert", + "service": { + "shortName": "TargetHttpProxies", + "fullName": "google.cloud.compute.v1.TargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpProxies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of TargetHttpProxy resources available to the specified project.", + "canonical": true, + "file": "target_http_proxies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetHttpProxyList", + "client": { + "shortName": "TargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpProxiesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.List", + "service": { + "shortName": "TargetHttpProxies", + "fullName": "google.cloud.compute.v1.TargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpProxies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "canonical": true, + "file": "target_http_proxies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_http_proxy", + "type": "TYPE_STRING" + }, + { + "name": "target_http_proxy_resource", + "type": ".google.cloud.compute.v1.TargetHttpProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpProxiesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.Patch", + "service": { + "shortName": "TargetHttpProxies", + "fullName": "google.cloud.compute.v1.TargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpProxies_SetUrlMap_async", + "title": "AcceleratorTypes setUrlMap Sample", + "origin": "API_DEFINITION", + "description": " Changes the URL map for TargetHttpProxy.", + "canonical": true, + "file": "target_http_proxies.set_url_map.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetUrlMap", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.SetUrlMap", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_http_proxy", + "type": "TYPE_STRING" + }, + { + "name": "url_map_reference_resource", + "type": ".google.cloud.compute.v1.UrlMapReference" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpProxiesClient" + }, + "method": { + "shortName": "SetUrlMap", + "fullName": "google.cloud.compute.v1.TargetHttpProxies.SetUrlMap", + "service": { + "shortName": "TargetHttpProxies", + "fullName": "google.cloud.compute.v1.TargetHttpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpsProxies_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.", + "canonical": true, + "file": "target_https_proxies.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetHttpsProxyAggregatedList", + "client": { + "shortName": "TargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpsProxiesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.AggregatedList", + "service": { + "shortName": "TargetHttpsProxies", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpsProxies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified TargetHttpsProxy resource.", + "canonical": true, + "file": "target_https_proxies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpsProxiesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.Delete", + "service": { + "shortName": "TargetHttpsProxies", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpsProxies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified TargetHttpsProxy resource.", + "canonical": true, + "file": "target_https_proxies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetHttpsProxy", + "client": { + "shortName": "TargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpsProxiesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.Get", + "service": { + "shortName": "TargetHttpsProxies", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpsProxies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a TargetHttpsProxy resource in the specified project using the data included in the request.", + "canonical": true, + "file": "target_https_proxies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy_resource", + "type": ".google.cloud.compute.v1.TargetHttpsProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpsProxiesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.Insert", + "service": { + "shortName": "TargetHttpsProxies", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpsProxies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of TargetHttpsProxy resources available to the specified project.", + "canonical": true, + "file": "target_https_proxies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetHttpsProxyList", + "client": { + "shortName": "TargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpsProxiesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.List", + "service": { + "shortName": "TargetHttpsProxies", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpsProxies_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", + "canonical": true, + "file": "target_https_proxies.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy_resource", + "type": ".google.cloud.compute.v1.TargetHttpsProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpsProxiesClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.Patch", + "service": { + "shortName": "TargetHttpsProxies", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpsProxies_SetCertificateMap_async", + "title": "AcceleratorTypes setCertificateMap Sample", + "origin": "API_DEFINITION", + "description": " Changes the Certificate Map for TargetHttpsProxy.", + "canonical": true, + "file": "target_https_proxies.set_certificate_map.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetCertificateMap", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.SetCertificateMap", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxies_set_certificate_map_request_resource", + "type": ".google.cloud.compute.v1.TargetHttpsProxiesSetCertificateMapRequest" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpsProxiesClient" + }, + "method": { + "shortName": "SetCertificateMap", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.SetCertificateMap", + "service": { + "shortName": "TargetHttpsProxies", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpsProxies_SetQuicOverride_async", + "title": "AcceleratorTypes setQuicOverride Sample", + "origin": "API_DEFINITION", + "description": " Sets the QUIC override policy for TargetHttpsProxy.", + "canonical": true, + "file": "target_https_proxies.set_quic_override.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetQuicOverride", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.SetQuicOverride", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxies_set_quic_override_request_resource", + "type": ".google.cloud.compute.v1.TargetHttpsProxiesSetQuicOverrideRequest" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpsProxiesClient" + }, + "method": { + "shortName": "SetQuicOverride", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.SetQuicOverride", + "service": { + "shortName": "TargetHttpsProxies", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpsProxies_SetSslCertificates_async", + "title": "AcceleratorTypes setSslCertificates Sample", + "origin": "API_DEFINITION", + "description": " Replaces SslCertificates for TargetHttpsProxy.", + "canonical": true, + "file": "target_https_proxies.set_ssl_certificates.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetSslCertificates", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.SetSslCertificates", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxies_set_ssl_certificates_request_resource", + "type": ".google.cloud.compute.v1.TargetHttpsProxiesSetSslCertificatesRequest" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpsProxiesClient" + }, + "method": { + "shortName": "SetSslCertificates", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.SetSslCertificates", + "service": { + "shortName": "TargetHttpsProxies", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpsProxies_SetSslPolicy_async", + "title": "AcceleratorTypes setSslPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.", + "canonical": true, + "file": "target_https_proxies.set_ssl_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetSslPolicy", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.SetSslPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy_reference_resource", + "type": ".google.cloud.compute.v1.SslPolicyReference" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpsProxiesClient" + }, + "method": { + "shortName": "SetSslPolicy", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.SetSslPolicy", + "service": { + "shortName": "TargetHttpsProxies", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetHttpsProxies_SetUrlMap_async", + "title": "AcceleratorTypes setUrlMap Sample", + "origin": "API_DEFINITION", + "description": " Changes the URL map for TargetHttpsProxy.", + "canonical": true, + "file": "target_https_proxies.set_url_map.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetUrlMap", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.SetUrlMap", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_https_proxy", + "type": "TYPE_STRING" + }, + { + "name": "url_map_reference_resource", + "type": ".google.cloud.compute.v1.UrlMapReference" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetHttpsProxiesClient", + "fullName": "google.cloud.compute.v1.TargetHttpsProxiesClient" + }, + "method": { + "shortName": "SetUrlMap", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies.SetUrlMap", + "service": { + "shortName": "TargetHttpsProxies", + "fullName": "google.cloud.compute.v1.TargetHttpsProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetInstances_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of target instances.", + "canonical": true, + "file": "target_instances.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetInstances.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetInstanceAggregatedList", + "client": { + "shortName": "TargetInstancesClient", + "fullName": "google.cloud.compute.v1.TargetInstancesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetInstances.AggregatedList", + "service": { + "shortName": "TargetInstances", + "fullName": "google.cloud.compute.v1.TargetInstances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetInstances_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified TargetInstance resource.", + "canonical": true, + "file": "target_instances.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetInstances.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_instance", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetInstancesClient", + "fullName": "google.cloud.compute.v1.TargetInstancesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetInstances.Delete", + "service": { + "shortName": "TargetInstances", + "fullName": "google.cloud.compute.v1.TargetInstances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetInstances_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified TargetInstance resource.", + "canonical": true, + "file": "target_instances.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetInstances.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "target_instance", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetInstance", + "client": { + "shortName": "TargetInstancesClient", + "fullName": "google.cloud.compute.v1.TargetInstancesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetInstances.Get", + "service": { + "shortName": "TargetInstances", + "fullName": "google.cloud.compute.v1.TargetInstances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetInstances_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a TargetInstance resource in the specified project and zone using the data included in the request.", + "canonical": true, + "file": "target_instances.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetInstances.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_instance_resource", + "type": ".google.cloud.compute.v1.TargetInstance" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetInstancesClient", + "fullName": "google.cloud.compute.v1.TargetInstancesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetInstances.Insert", + "service": { + "shortName": "TargetInstances", + "fullName": "google.cloud.compute.v1.TargetInstances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetInstances_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of TargetInstance resources available to the specified project and zone.", + "canonical": true, + "file": "target_instances.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetInstances.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetInstanceList", + "client": { + "shortName": "TargetInstancesClient", + "fullName": "google.cloud.compute.v1.TargetInstancesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetInstances.List", + "service": { + "shortName": "TargetInstances", + "fullName": "google.cloud.compute.v1.TargetInstances" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetPools_AddHealthCheck_async", + "title": "AcceleratorTypes addHealthCheck Sample", + "origin": "API_DEFINITION", + "description": " Adds health check URLs to a target pool.", + "canonical": true, + "file": "target_pools.add_health_check.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddHealthCheck", + "fullName": "google.cloud.compute.v1.TargetPools.AddHealthCheck", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_pool", + "type": "TYPE_STRING" + }, + { + "name": "target_pools_add_health_check_request_resource", + "type": ".google.cloud.compute.v1.TargetPoolsAddHealthCheckRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetPoolsClient", + "fullName": "google.cloud.compute.v1.TargetPoolsClient" + }, + "method": { + "shortName": "AddHealthCheck", + "fullName": "google.cloud.compute.v1.TargetPools.AddHealthCheck", + "service": { + "shortName": "TargetPools", + "fullName": "google.cloud.compute.v1.TargetPools" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetPools_AddInstance_async", + "title": "AcceleratorTypes addInstance Sample", + "origin": "API_DEFINITION", + "description": " Adds an instance to a target pool.", + "canonical": true, + "file": "target_pools.add_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddInstance", + "fullName": "google.cloud.compute.v1.TargetPools.AddInstance", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_pool", + "type": "TYPE_STRING" + }, + { + "name": "target_pools_add_instance_request_resource", + "type": ".google.cloud.compute.v1.TargetPoolsAddInstanceRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetPoolsClient", + "fullName": "google.cloud.compute.v1.TargetPoolsClient" + }, + "method": { + "shortName": "AddInstance", + "fullName": "google.cloud.compute.v1.TargetPools.AddInstance", + "service": { + "shortName": "TargetPools", + "fullName": "google.cloud.compute.v1.TargetPools" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetPools_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of target pools.", + "canonical": true, + "file": "target_pools.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetPools.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetPoolAggregatedList", + "client": { + "shortName": "TargetPoolsClient", + "fullName": "google.cloud.compute.v1.TargetPoolsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetPools.AggregatedList", + "service": { + "shortName": "TargetPools", + "fullName": "google.cloud.compute.v1.TargetPools" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetPools_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified target pool.", + "canonical": true, + "file": "target_pools.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetPools.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_pool", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetPoolsClient", + "fullName": "google.cloud.compute.v1.TargetPoolsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetPools.Delete", + "service": { + "shortName": "TargetPools", + "fullName": "google.cloud.compute.v1.TargetPools" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetPools_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified target pool.", + "canonical": true, + "file": "target_pools.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetPools.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "target_pool", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetPool", + "client": { + "shortName": "TargetPoolsClient", + "fullName": "google.cloud.compute.v1.TargetPoolsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetPools.Get", + "service": { + "shortName": "TargetPools", + "fullName": "google.cloud.compute.v1.TargetPools" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetPools_GetHealth_async", + "title": "AcceleratorTypes getHealth Sample", + "origin": "API_DEFINITION", + "description": " Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.", + "canonical": true, + "file": "target_pools.get_health.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetHealth", + "fullName": "google.cloud.compute.v1.TargetPools.GetHealth", + "async": true, + "parameters": [ + { + "name": "instance_reference_resource", + "type": ".google.cloud.compute.v1.InstanceReference" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "target_pool", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetPoolInstanceHealth", + "client": { + "shortName": "TargetPoolsClient", + "fullName": "google.cloud.compute.v1.TargetPoolsClient" + }, + "method": { + "shortName": "GetHealth", + "fullName": "google.cloud.compute.v1.TargetPools.GetHealth", + "service": { + "shortName": "TargetPools", + "fullName": "google.cloud.compute.v1.TargetPools" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetPools_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a target pool in the specified project and region using the data included in the request.", + "canonical": true, + "file": "target_pools.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetPools.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_pool_resource", + "type": ".google.cloud.compute.v1.TargetPool" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetPoolsClient", + "fullName": "google.cloud.compute.v1.TargetPoolsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetPools.Insert", + "service": { + "shortName": "TargetPools", + "fullName": "google.cloud.compute.v1.TargetPools" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetPools_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of target pools available to the specified project and region.", + "canonical": true, + "file": "target_pools.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetPools.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetPoolList", + "client": { + "shortName": "TargetPoolsClient", + "fullName": "google.cloud.compute.v1.TargetPoolsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetPools.List", + "service": { + "shortName": "TargetPools", + "fullName": "google.cloud.compute.v1.TargetPools" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetPools_RemoveHealthCheck_async", + "title": "AcceleratorTypes removeHealthCheck Sample", + "origin": "API_DEFINITION", + "description": " Removes health check URL from a target pool.", + "canonical": true, + "file": "target_pools.remove_health_check.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveHealthCheck", + "fullName": "google.cloud.compute.v1.TargetPools.RemoveHealthCheck", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_pool", + "type": "TYPE_STRING" + }, + { + "name": "target_pools_remove_health_check_request_resource", + "type": ".google.cloud.compute.v1.TargetPoolsRemoveHealthCheckRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetPoolsClient", + "fullName": "google.cloud.compute.v1.TargetPoolsClient" + }, + "method": { + "shortName": "RemoveHealthCheck", + "fullName": "google.cloud.compute.v1.TargetPools.RemoveHealthCheck", + "service": { + "shortName": "TargetPools", + "fullName": "google.cloud.compute.v1.TargetPools" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetPools_RemoveInstance_async", + "title": "AcceleratorTypes removeInstance Sample", + "origin": "API_DEFINITION", + "description": " Removes instance URL from a target pool.", + "canonical": true, + "file": "target_pools.remove_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveInstance", + "fullName": "google.cloud.compute.v1.TargetPools.RemoveInstance", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_pool", + "type": "TYPE_STRING" + }, + { + "name": "target_pools_remove_instance_request_resource", + "type": ".google.cloud.compute.v1.TargetPoolsRemoveInstanceRequest" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetPoolsClient", + "fullName": "google.cloud.compute.v1.TargetPoolsClient" + }, + "method": { + "shortName": "RemoveInstance", + "fullName": "google.cloud.compute.v1.TargetPools.RemoveInstance", + "service": { + "shortName": "TargetPools", + "fullName": "google.cloud.compute.v1.TargetPools" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetPools_SetBackup_async", + "title": "AcceleratorTypes setBackup Sample", + "origin": "API_DEFINITION", + "description": " Changes a backup target pool's configurations.", + "canonical": true, + "file": "target_pools.set_backup.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetBackup", + "fullName": "google.cloud.compute.v1.TargetPools.SetBackup", + "async": true, + "parameters": [ + { + "name": "failover_ratio", + "type": "TYPE_FLOAT" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_pool", + "type": "TYPE_STRING" + }, + { + "name": "target_reference_resource", + "type": ".google.cloud.compute.v1.TargetReference" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetPoolsClient", + "fullName": "google.cloud.compute.v1.TargetPoolsClient" + }, + "method": { + "shortName": "SetBackup", + "fullName": "google.cloud.compute.v1.TargetPools.SetBackup", + "service": { + "shortName": "TargetPools", + "fullName": "google.cloud.compute.v1.TargetPools" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetSslProxies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified TargetSslProxy resource.", + "canonical": true, + "file": "target_ssl_proxies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetSslProxies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_ssl_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetSslProxiesClient", + "fullName": "google.cloud.compute.v1.TargetSslProxiesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetSslProxies.Delete", + "service": { + "shortName": "TargetSslProxies", + "fullName": "google.cloud.compute.v1.TargetSslProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetSslProxies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified TargetSslProxy resource.", + "canonical": true, + "file": "target_ssl_proxies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetSslProxies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "target_ssl_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetSslProxy", + "client": { + "shortName": "TargetSslProxiesClient", + "fullName": "google.cloud.compute.v1.TargetSslProxiesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetSslProxies.Get", + "service": { + "shortName": "TargetSslProxies", + "fullName": "google.cloud.compute.v1.TargetSslProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetSslProxies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a TargetSslProxy resource in the specified project using the data included in the request.", + "canonical": true, + "file": "target_ssl_proxies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetSslProxies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_ssl_proxy_resource", + "type": ".google.cloud.compute.v1.TargetSslProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetSslProxiesClient", + "fullName": "google.cloud.compute.v1.TargetSslProxiesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetSslProxies.Insert", + "service": { + "shortName": "TargetSslProxies", + "fullName": "google.cloud.compute.v1.TargetSslProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetSslProxies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of TargetSslProxy resources available to the specified project.", + "canonical": true, + "file": "target_ssl_proxies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetSslProxies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetSslProxyList", + "client": { + "shortName": "TargetSslProxiesClient", + "fullName": "google.cloud.compute.v1.TargetSslProxiesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetSslProxies.List", + "service": { + "shortName": "TargetSslProxies", + "fullName": "google.cloud.compute.v1.TargetSslProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetSslProxies_SetBackendService_async", + "title": "AcceleratorTypes setBackendService Sample", + "origin": "API_DEFINITION", + "description": " Changes the BackendService for TargetSslProxy.", + "canonical": true, + "file": "target_ssl_proxies.set_backend_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetBackendService", + "fullName": "google.cloud.compute.v1.TargetSslProxies.SetBackendService", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_ssl_proxies_set_backend_service_request_resource", + "type": ".google.cloud.compute.v1.TargetSslProxiesSetBackendServiceRequest" + }, + { + "name": "target_ssl_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetSslProxiesClient", + "fullName": "google.cloud.compute.v1.TargetSslProxiesClient" + }, + "method": { + "shortName": "SetBackendService", + "fullName": "google.cloud.compute.v1.TargetSslProxies.SetBackendService", + "service": { + "shortName": "TargetSslProxies", + "fullName": "google.cloud.compute.v1.TargetSslProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetSslProxies_SetCertificateMap_async", + "title": "AcceleratorTypes setCertificateMap Sample", + "origin": "API_DEFINITION", + "description": " Changes the Certificate Map for TargetSslProxy.", + "canonical": true, + "file": "target_ssl_proxies.set_certificate_map.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetCertificateMap", + "fullName": "google.cloud.compute.v1.TargetSslProxies.SetCertificateMap", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_ssl_proxies_set_certificate_map_request_resource", + "type": ".google.cloud.compute.v1.TargetSslProxiesSetCertificateMapRequest" + }, + { + "name": "target_ssl_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetSslProxiesClient", + "fullName": "google.cloud.compute.v1.TargetSslProxiesClient" + }, + "method": { + "shortName": "SetCertificateMap", + "fullName": "google.cloud.compute.v1.TargetSslProxies.SetCertificateMap", + "service": { + "shortName": "TargetSslProxies", + "fullName": "google.cloud.compute.v1.TargetSslProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetSslProxies_SetProxyHeader_async", + "title": "AcceleratorTypes setProxyHeader Sample", + "origin": "API_DEFINITION", + "description": " Changes the ProxyHeaderType for TargetSslProxy.", + "canonical": true, + "file": "target_ssl_proxies.set_proxy_header.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetProxyHeader", + "fullName": "google.cloud.compute.v1.TargetSslProxies.SetProxyHeader", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_ssl_proxies_set_proxy_header_request_resource", + "type": ".google.cloud.compute.v1.TargetSslProxiesSetProxyHeaderRequest" + }, + { + "name": "target_ssl_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetSslProxiesClient", + "fullName": "google.cloud.compute.v1.TargetSslProxiesClient" + }, + "method": { + "shortName": "SetProxyHeader", + "fullName": "google.cloud.compute.v1.TargetSslProxies.SetProxyHeader", + "service": { + "shortName": "TargetSslProxies", + "fullName": "google.cloud.compute.v1.TargetSslProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetSslProxies_SetSslCertificates_async", + "title": "AcceleratorTypes setSslCertificates Sample", + "origin": "API_DEFINITION", + "description": " Changes SslCertificates for TargetSslProxy.", + "canonical": true, + "file": "target_ssl_proxies.set_ssl_certificates.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetSslCertificates", + "fullName": "google.cloud.compute.v1.TargetSslProxies.SetSslCertificates", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_ssl_proxies_set_ssl_certificates_request_resource", + "type": ".google.cloud.compute.v1.TargetSslProxiesSetSslCertificatesRequest" + }, + { + "name": "target_ssl_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetSslProxiesClient", + "fullName": "google.cloud.compute.v1.TargetSslProxiesClient" + }, + "method": { + "shortName": "SetSslCertificates", + "fullName": "google.cloud.compute.v1.TargetSslProxies.SetSslCertificates", + "service": { + "shortName": "TargetSslProxies", + "fullName": "google.cloud.compute.v1.TargetSslProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetSslProxies_SetSslPolicy_async", + "title": "AcceleratorTypes setSslPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends.", + "canonical": true, + "file": "target_ssl_proxies.set_ssl_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetSslPolicy", + "fullName": "google.cloud.compute.v1.TargetSslProxies.SetSslPolicy", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "ssl_policy_reference_resource", + "type": ".google.cloud.compute.v1.SslPolicyReference" + }, + { + "name": "target_ssl_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetSslProxiesClient", + "fullName": "google.cloud.compute.v1.TargetSslProxiesClient" + }, + "method": { + "shortName": "SetSslPolicy", + "fullName": "google.cloud.compute.v1.TargetSslProxies.SetSslPolicy", + "service": { + "shortName": "TargetSslProxies", + "fullName": "google.cloud.compute.v1.TargetSslProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetTcpProxies_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project.", + "canonical": true, + "file": "target_tcp_proxies.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetTcpProxyAggregatedList", + "client": { + "shortName": "TargetTcpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetTcpProxiesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.AggregatedList", + "service": { + "shortName": "TargetTcpProxies", + "fullName": "google.cloud.compute.v1.TargetTcpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetTcpProxies_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified TargetTcpProxy resource.", + "canonical": true, + "file": "target_tcp_proxies.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_tcp_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetTcpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetTcpProxiesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.Delete", + "service": { + "shortName": "TargetTcpProxies", + "fullName": "google.cloud.compute.v1.TargetTcpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetTcpProxies_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified TargetTcpProxy resource.", + "canonical": true, + "file": "target_tcp_proxies.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "target_tcp_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetTcpProxy", + "client": { + "shortName": "TargetTcpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetTcpProxiesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.Get", + "service": { + "shortName": "TargetTcpProxies", + "fullName": "google.cloud.compute.v1.TargetTcpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetTcpProxies_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a TargetTcpProxy resource in the specified project using the data included in the request.", + "canonical": true, + "file": "target_tcp_proxies.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_tcp_proxy_resource", + "type": ".google.cloud.compute.v1.TargetTcpProxy" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetTcpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetTcpProxiesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.Insert", + "service": { + "shortName": "TargetTcpProxies", + "fullName": "google.cloud.compute.v1.TargetTcpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetTcpProxies_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of TargetTcpProxy resources available to the specified project.", + "canonical": true, + "file": "target_tcp_proxies.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetTcpProxyList", + "client": { + "shortName": "TargetTcpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetTcpProxiesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.List", + "service": { + "shortName": "TargetTcpProxies", + "fullName": "google.cloud.compute.v1.TargetTcpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetTcpProxies_SetBackendService_async", + "title": "AcceleratorTypes setBackendService Sample", + "origin": "API_DEFINITION", + "description": " Changes the BackendService for TargetTcpProxy.", + "canonical": true, + "file": "target_tcp_proxies.set_backend_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetBackendService", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.SetBackendService", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_tcp_proxies_set_backend_service_request_resource", + "type": ".google.cloud.compute.v1.TargetTcpProxiesSetBackendServiceRequest" + }, + { + "name": "target_tcp_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetTcpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetTcpProxiesClient" + }, + "method": { + "shortName": "SetBackendService", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.SetBackendService", + "service": { + "shortName": "TargetTcpProxies", + "fullName": "google.cloud.compute.v1.TargetTcpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetTcpProxies_SetProxyHeader_async", + "title": "AcceleratorTypes setProxyHeader Sample", + "origin": "API_DEFINITION", + "description": " Changes the ProxyHeaderType for TargetTcpProxy.", + "canonical": true, + "file": "target_tcp_proxies.set_proxy_header.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetProxyHeader", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.SetProxyHeader", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_tcp_proxies_set_proxy_header_request_resource", + "type": ".google.cloud.compute.v1.TargetTcpProxiesSetProxyHeaderRequest" + }, + { + "name": "target_tcp_proxy", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetTcpProxiesClient", + "fullName": "google.cloud.compute.v1.TargetTcpProxiesClient" + }, + "method": { + "shortName": "SetProxyHeader", + "fullName": "google.cloud.compute.v1.TargetTcpProxies.SetProxyHeader", + "service": { + "shortName": "TargetTcpProxies", + "fullName": "google.cloud.compute.v1.TargetTcpProxies" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetVpnGateways_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of target VPN gateways.", + "canonical": true, + "file": "target_vpn_gateways.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetVpnGatewayAggregatedList", + "client": { + "shortName": "TargetVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.TargetVpnGatewaysClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.AggregatedList", + "service": { + "shortName": "TargetVpnGateways", + "fullName": "google.cloud.compute.v1.TargetVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetVpnGateways_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified target VPN gateway.", + "canonical": true, + "file": "target_vpn_gateways.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_vpn_gateway", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.TargetVpnGatewaysClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.Delete", + "service": { + "shortName": "TargetVpnGateways", + "fullName": "google.cloud.compute.v1.TargetVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetVpnGateways_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified target VPN gateway.", + "canonical": true, + "file": "target_vpn_gateways.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "target_vpn_gateway", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.TargetVpnGateway", + "client": { + "shortName": "TargetVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.TargetVpnGatewaysClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.Get", + "service": { + "shortName": "TargetVpnGateways", + "fullName": "google.cloud.compute.v1.TargetVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetVpnGateways_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a target VPN gateway in the specified project and region using the data included in the request.", + "canonical": true, + "file": "target_vpn_gateways.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "target_vpn_gateway_resource", + "type": ".google.cloud.compute.v1.TargetVpnGateway" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.TargetVpnGatewaysClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.Insert", + "service": { + "shortName": "TargetVpnGateways", + "fullName": "google.cloud.compute.v1.TargetVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetVpnGateways_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of target VPN gateways available to the specified project and region.", + "canonical": true, + "file": "target_vpn_gateways.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.TargetVpnGatewayList", + "client": { + "shortName": "TargetVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.TargetVpnGatewaysClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.List", + "service": { + "shortName": "TargetVpnGateways", + "fullName": "google.cloud.compute.v1.TargetVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_TargetVpnGateways_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "target_vpn_gateways.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.SetLabels", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_labels_request_resource", + "type": ".google.cloud.compute.v1.RegionSetLabelsRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "TargetVpnGatewaysClient", + "fullName": "google.cloud.compute.v1.TargetVpnGatewaysClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.TargetVpnGateways.SetLabels", + "service": { + "shortName": "TargetVpnGateways", + "fullName": "google.cloud.compute.v1.TargetVpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_UrlMaps_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of all UrlMap resources, regional and global, available to the specified project.", + "canonical": true, + "file": "url_maps.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.UrlMaps.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.UrlMapsAggregatedList", + "client": { + "shortName": "UrlMapsClient", + "fullName": "google.cloud.compute.v1.UrlMapsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.UrlMaps.AggregatedList", + "service": { + "shortName": "UrlMaps", + "fullName": "google.cloud.compute.v1.UrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_UrlMaps_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified UrlMap resource.", + "canonical": true, + "file": "url_maps.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.UrlMaps.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "url_map", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "UrlMapsClient", + "fullName": "google.cloud.compute.v1.UrlMapsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.UrlMaps.Delete", + "service": { + "shortName": "UrlMaps", + "fullName": "google.cloud.compute.v1.UrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_UrlMaps_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified UrlMap resource.", + "canonical": true, + "file": "url_maps.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.UrlMaps.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "url_map", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.UrlMap", + "client": { + "shortName": "UrlMapsClient", + "fullName": "google.cloud.compute.v1.UrlMapsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.UrlMaps.Get", + "service": { + "shortName": "UrlMaps", + "fullName": "google.cloud.compute.v1.UrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_UrlMaps_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a UrlMap resource in the specified project using the data included in the request.", + "canonical": true, + "file": "url_maps.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.UrlMaps.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "url_map_resource", + "type": ".google.cloud.compute.v1.UrlMap" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "UrlMapsClient", + "fullName": "google.cloud.compute.v1.UrlMapsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.UrlMaps.Insert", + "service": { + "shortName": "UrlMaps", + "fullName": "google.cloud.compute.v1.UrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_UrlMaps_InvalidateCache_async", + "title": "AcceleratorTypes invalidateCache Sample", + "origin": "API_DEFINITION", + "description": " Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).", + "canonical": true, + "file": "url_maps.invalidate_cache.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "InvalidateCache", + "fullName": "google.cloud.compute.v1.UrlMaps.InvalidateCache", + "async": true, + "parameters": [ + { + "name": "cache_invalidation_rule_resource", + "type": ".google.cloud.compute.v1.CacheInvalidationRule" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "url_map", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "UrlMapsClient", + "fullName": "google.cloud.compute.v1.UrlMapsClient" + }, + "method": { + "shortName": "InvalidateCache", + "fullName": "google.cloud.compute.v1.UrlMaps.InvalidateCache", + "service": { + "shortName": "UrlMaps", + "fullName": "google.cloud.compute.v1.UrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_UrlMaps_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of UrlMap resources available to the specified project.", + "canonical": true, + "file": "url_maps.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.UrlMaps.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.UrlMapList", + "client": { + "shortName": "UrlMapsClient", + "fullName": "google.cloud.compute.v1.UrlMapsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.UrlMaps.List", + "service": { + "shortName": "UrlMaps", + "fullName": "google.cloud.compute.v1.UrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_UrlMaps_Patch_async", + "title": "AcceleratorTypes patch Sample", + "origin": "API_DEFINITION", + "description": " Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "canonical": true, + "file": "url_maps.patch.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.UrlMaps.Patch", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "url_map", + "type": "TYPE_STRING" + }, + { + "name": "url_map_resource", + "type": ".google.cloud.compute.v1.UrlMap" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "UrlMapsClient", + "fullName": "google.cloud.compute.v1.UrlMapsClient" + }, + "method": { + "shortName": "Patch", + "fullName": "google.cloud.compute.v1.UrlMaps.Patch", + "service": { + "shortName": "UrlMaps", + "fullName": "google.cloud.compute.v1.UrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_UrlMaps_Update_async", + "title": "AcceleratorTypes update Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified UrlMap resource with the data included in the request.", + "canonical": true, + "file": "url_maps.update.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.UrlMaps.Update", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "url_map", + "type": "TYPE_STRING" + }, + { + "name": "url_map_resource", + "type": ".google.cloud.compute.v1.UrlMap" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "UrlMapsClient", + "fullName": "google.cloud.compute.v1.UrlMapsClient" + }, + "method": { + "shortName": "Update", + "fullName": "google.cloud.compute.v1.UrlMaps.Update", + "service": { + "shortName": "UrlMaps", + "fullName": "google.cloud.compute.v1.UrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_UrlMaps_Validate_async", + "title": "AcceleratorTypes validate Sample", + "origin": "API_DEFINITION", + "description": " Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.", + "canonical": true, + "file": "url_maps.validate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Validate", + "fullName": "google.cloud.compute.v1.UrlMaps.Validate", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "url_map", + "type": "TYPE_STRING" + }, + { + "name": "url_maps_validate_request_resource", + "type": ".google.cloud.compute.v1.UrlMapsValidateRequest" + } + ], + "resultType": ".google.cloud.compute.v1.UrlMapsValidateResponse", + "client": { + "shortName": "UrlMapsClient", + "fullName": "google.cloud.compute.v1.UrlMapsClient" + }, + "method": { + "shortName": "Validate", + "fullName": "google.cloud.compute.v1.UrlMaps.Validate", + "service": { + "shortName": "UrlMaps", + "fullName": "google.cloud.compute.v1.UrlMaps" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnGateways_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of VPN gateways.", + "canonical": true, + "file": "vpn_gateways.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.VpnGateways.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.VpnGatewayAggregatedList", + "client": { + "shortName": "VpnGatewaysClient", + "fullName": "google.cloud.compute.v1.VpnGatewaysClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.VpnGateways.AggregatedList", + "service": { + "shortName": "VpnGateways", + "fullName": "google.cloud.compute.v1.VpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnGateways_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified VPN gateway.", + "canonical": true, + "file": "vpn_gateways.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.VpnGateways.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "vpn_gateway", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "VpnGatewaysClient", + "fullName": "google.cloud.compute.v1.VpnGatewaysClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.VpnGateways.Delete", + "service": { + "shortName": "VpnGateways", + "fullName": "google.cloud.compute.v1.VpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnGateways_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified VPN gateway.", + "canonical": true, + "file": "vpn_gateways.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.VpnGateways.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "vpn_gateway", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.VpnGateway", + "client": { + "shortName": "VpnGatewaysClient", + "fullName": "google.cloud.compute.v1.VpnGatewaysClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.VpnGateways.Get", + "service": { + "shortName": "VpnGateways", + "fullName": "google.cloud.compute.v1.VpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnGateways_GetStatus_async", + "title": "AcceleratorTypes getStatus Sample", + "origin": "API_DEFINITION", + "description": " Returns the status for the specified VPN gateway.", + "canonical": true, + "file": "vpn_gateways.get_status.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetStatus", + "fullName": "google.cloud.compute.v1.VpnGateways.GetStatus", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "vpn_gateway", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.VpnGatewaysGetStatusResponse", + "client": { + "shortName": "VpnGatewaysClient", + "fullName": "google.cloud.compute.v1.VpnGatewaysClient" + }, + "method": { + "shortName": "GetStatus", + "fullName": "google.cloud.compute.v1.VpnGateways.GetStatus", + "service": { + "shortName": "VpnGateways", + "fullName": "google.cloud.compute.v1.VpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnGateways_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a VPN gateway in the specified project and region using the data included in the request.", + "canonical": true, + "file": "vpn_gateways.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.VpnGateways.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "vpn_gateway_resource", + "type": ".google.cloud.compute.v1.VpnGateway" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "VpnGatewaysClient", + "fullName": "google.cloud.compute.v1.VpnGatewaysClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.VpnGateways.Insert", + "service": { + "shortName": "VpnGateways", + "fullName": "google.cloud.compute.v1.VpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnGateways_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of VPN gateways available to the specified project and region.", + "canonical": true, + "file": "vpn_gateways.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.VpnGateways.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.VpnGatewayList", + "client": { + "shortName": "VpnGatewaysClient", + "fullName": "google.cloud.compute.v1.VpnGatewaysClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.VpnGateways.List", + "service": { + "shortName": "VpnGateways", + "fullName": "google.cloud.compute.v1.VpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnGateways_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "vpn_gateways.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.VpnGateways.SetLabels", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_labels_request_resource", + "type": ".google.cloud.compute.v1.RegionSetLabelsRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "VpnGatewaysClient", + "fullName": "google.cloud.compute.v1.VpnGatewaysClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.VpnGateways.SetLabels", + "service": { + "shortName": "VpnGateways", + "fullName": "google.cloud.compute.v1.VpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnGateways_TestIamPermissions_async", + "title": "AcceleratorTypes testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource.", + "canonical": true, + "file": "vpn_gateways.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.VpnGateways.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "test_permissions_request_resource", + "type": ".google.cloud.compute.v1.TestPermissionsRequest" + } + ], + "resultType": ".google.cloud.compute.v1.TestPermissionsResponse", + "client": { + "shortName": "VpnGatewaysClient", + "fullName": "google.cloud.compute.v1.VpnGatewaysClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.compute.v1.VpnGateways.TestIamPermissions", + "service": { + "shortName": "VpnGateways", + "fullName": "google.cloud.compute.v1.VpnGateways" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnTunnels_AggregatedList_async", + "title": "AcceleratorTypes aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of VPN tunnels.", + "canonical": true, + "file": "vpn_tunnels.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.VpnTunnels.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.VpnTunnelAggregatedList", + "client": { + "shortName": "VpnTunnelsClient", + "fullName": "google.cloud.compute.v1.VpnTunnelsClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1.VpnTunnels.AggregatedList", + "service": { + "shortName": "VpnTunnels", + "fullName": "google.cloud.compute.v1.VpnTunnels" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnTunnels_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified VpnTunnel resource.", + "canonical": true, + "file": "vpn_tunnels.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.VpnTunnels.Delete", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "vpn_tunnel", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "VpnTunnelsClient", + "fullName": "google.cloud.compute.v1.VpnTunnelsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.VpnTunnels.Delete", + "service": { + "shortName": "VpnTunnels", + "fullName": "google.cloud.compute.v1.VpnTunnels" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnTunnels_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified VpnTunnel resource.", + "canonical": true, + "file": "vpn_tunnels.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.VpnTunnels.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "vpn_tunnel", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.VpnTunnel", + "client": { + "shortName": "VpnTunnelsClient", + "fullName": "google.cloud.compute.v1.VpnTunnelsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.VpnTunnels.Get", + "service": { + "shortName": "VpnTunnels", + "fullName": "google.cloud.compute.v1.VpnTunnels" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnTunnels_Insert_async", + "title": "AcceleratorTypes insert Sample", + "origin": "API_DEFINITION", + "description": " Creates a VpnTunnel resource in the specified project and region using the data included in the request.", + "canonical": true, + "file": "vpn_tunnels.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.VpnTunnels.Insert", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "vpn_tunnel_resource", + "type": ".google.cloud.compute.v1.VpnTunnel" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "VpnTunnelsClient", + "fullName": "google.cloud.compute.v1.VpnTunnelsClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1.VpnTunnels.Insert", + "service": { + "shortName": "VpnTunnels", + "fullName": "google.cloud.compute.v1.VpnTunnels" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnTunnels_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of VpnTunnel resources contained in the specified project and region.", + "canonical": true, + "file": "vpn_tunnels.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.VpnTunnels.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.VpnTunnelList", + "client": { + "shortName": "VpnTunnelsClient", + "fullName": "google.cloud.compute.v1.VpnTunnelsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.VpnTunnels.List", + "service": { + "shortName": "VpnTunnels", + "fullName": "google.cloud.compute.v1.VpnTunnels" + } + } + } + }, + { + "regionTag": "compute_v1_generated_VpnTunnels_SetLabels_async", + "title": "AcceleratorTypes setLabels Sample", + "origin": "API_DEFINITION", + "description": " Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.", + "canonical": true, + "file": "vpn_tunnels.set_labels.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.VpnTunnels.SetLabels", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "region_set_labels_request_resource", + "type": ".google.cloud.compute.v1.RegionSetLabelsRequest" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "VpnTunnelsClient", + "fullName": "google.cloud.compute.v1.VpnTunnelsClient" + }, + "method": { + "shortName": "SetLabels", + "fullName": "google.cloud.compute.v1.VpnTunnels.SetLabels", + "service": { + "shortName": "VpnTunnels", + "fullName": "google.cloud.compute.v1.VpnTunnels" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ZoneOperations_Delete_async", + "title": "AcceleratorTypes delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified zone-specific Operations resource.", + "canonical": true, + "file": "zone_operations.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.ZoneOperations.Delete", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.DeleteZoneOperationResponse", + "client": { + "shortName": "ZoneOperationsClient", + "fullName": "google.cloud.compute.v1.ZoneOperationsClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1.ZoneOperations.Delete", + "service": { + "shortName": "ZoneOperations", + "fullName": "google.cloud.compute.v1.ZoneOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ZoneOperations_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the specified zone-specific Operations resource.", + "canonical": true, + "file": "zone_operations.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ZoneOperations.Get", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ZoneOperationsClient", + "fullName": "google.cloud.compute.v1.ZoneOperationsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.ZoneOperations.Get", + "service": { + "shortName": "ZoneOperations", + "fullName": "google.cloud.compute.v1.ZoneOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ZoneOperations_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of Operation resources contained within the specified zone.", + "canonical": true, + "file": "zone_operations.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.ZoneOperations.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.OperationList", + "client": { + "shortName": "ZoneOperationsClient", + "fullName": "google.cloud.compute.v1.ZoneOperationsClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.ZoneOperations.List", + "service": { + "shortName": "ZoneOperations", + "fullName": "google.cloud.compute.v1.ZoneOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_ZoneOperations_Wait_async", + "title": "AcceleratorTypes wait Sample", + "origin": "API_DEFINITION", + "description": " Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", + "canonical": true, + "file": "zone_operations.wait.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Wait", + "fullName": "google.cloud.compute.v1.ZoneOperations.Wait", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Operation", + "client": { + "shortName": "ZoneOperationsClient", + "fullName": "google.cloud.compute.v1.ZoneOperationsClient" + }, + "method": { + "shortName": "Wait", + "fullName": "google.cloud.compute.v1.ZoneOperations.Wait", + "service": { + "shortName": "ZoneOperations", + "fullName": "google.cloud.compute.v1.ZoneOperations" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Zones_Get_async", + "title": "AcceleratorTypes get Sample", + "origin": "API_DEFINITION", + "description": " Returns the specified Zone resource.", + "canonical": true, + "file": "zones.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Zones.Get", + "async": true, + "parameters": [ + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1.Zone", + "client": { + "shortName": "ZonesClient", + "fullName": "google.cloud.compute.v1.ZonesClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1.Zones.Get", + "service": { + "shortName": "Zones", + "fullName": "google.cloud.compute.v1.Zones" + } + } + } + }, + { + "regionTag": "compute_v1_generated_Zones_List_async", + "title": "AcceleratorTypes list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the list of Zone resources available to the specified project.", + "canonical": true, + "file": "zones.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Zones.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "return_partial_success", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.compute.v1.ZoneList", + "client": { + "shortName": "ZonesClient", + "fullName": "google.cloud.compute.v1.ZonesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1.Zones.List", + "service": { + "shortName": "Zones", + "fullName": "google.cloud.compute.v1.Zones" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-compute/samples/generated/v1small/snippet_metadata_google.cloud.compute.v1small.json b/packages/google-cloud-compute/samples/generated/v1small/snippet_metadata_google.cloud.compute.v1small.json new file mode 100644 index 000000000000..a67b4c80a873 --- /dev/null +++ b/packages/google-cloud-compute/samples/generated/v1small/snippet_metadata_google.cloud.compute.v1small.json @@ -0,0 +1,335 @@ +{ + "clientLibrary": { + "name": "nodejs-compute", + "version": "3.10.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.compute.v1small", + "version": "v1small" + } + ] + }, + "snippets": [ + { + "regionTag": "compute_v1small_generated_Addresses_AggregatedList_async", + "title": "Addresses aggregatedList Sample", + "origin": "API_DEFINITION", + "description": " Retrieves an aggregated list of addresses.", + "canonical": true, + "file": "addresses.aggregated_list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1small.Addresses.AggregatedList", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "include_all_scopes", + "type": "TYPE_BOOL" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1small.AddressAggregatedList", + "client": { + "shortName": "AddressesClient", + "fullName": "google.cloud.compute.v1small.AddressesClient" + }, + "method": { + "shortName": "AggregatedList", + "fullName": "google.cloud.compute.v1small.Addresses.AggregatedList", + "service": { + "shortName": "Addresses", + "fullName": "google.cloud.compute.v1small.Addresses" + } + } + } + }, + { + "regionTag": "compute_v1small_generated_Addresses_Delete_async", + "title": "Addresses delete Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified address resource.", + "canonical": true, + "file": "addresses.delete.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1small.Addresses.Delete", + "async": true, + "parameters": [ + { + "name": "address", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1small.Operation", + "client": { + "shortName": "AddressesClient", + "fullName": "google.cloud.compute.v1small.AddressesClient" + }, + "method": { + "shortName": "Delete", + "fullName": "google.cloud.compute.v1small.Addresses.Delete", + "service": { + "shortName": "Addresses", + "fullName": "google.cloud.compute.v1small.Addresses" + } + } + } + }, + { + "regionTag": "compute_v1small_generated_Addresses_Insert_async", + "title": "Addresses insert Sample", + "origin": "API_DEFINITION", + "description": " Creates an address resource in the specified project by using the data included in the request.", + "canonical": true, + "file": "addresses.insert.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1small.Addresses.Insert", + "async": true, + "parameters": [ + { + "name": "address_resource", + "type": ".google.cloud.compute.v1small.Address" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1small.Operation", + "client": { + "shortName": "AddressesClient", + "fullName": "google.cloud.compute.v1small.AddressesClient" + }, + "method": { + "shortName": "Insert", + "fullName": "google.cloud.compute.v1small.Addresses.Insert", + "service": { + "shortName": "Addresses", + "fullName": "google.cloud.compute.v1small.Addresses" + } + } + } + }, + { + "regionTag": "compute_v1small_generated_Addresses_List_async", + "title": "Addresses list Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of addresses contained within the specified region.", + "canonical": true, + "file": "addresses.list.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "List", + "fullName": "google.cloud.compute.v1small.Addresses.List", + "async": true, + "parameters": [ + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": "TYPE_UINT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1small.AddressList", + "client": { + "shortName": "AddressesClient", + "fullName": "google.cloud.compute.v1small.AddressesClient" + }, + "method": { + "shortName": "List", + "fullName": "google.cloud.compute.v1small.Addresses.List", + "service": { + "shortName": "Addresses", + "fullName": "google.cloud.compute.v1small.Addresses" + } + } + } + }, + { + "regionTag": "compute_v1small_generated_RegionOperations_Get_async", + "title": "Addresses get Sample", + "origin": "API_DEFINITION", + "description": " Retrieves the specified region-specific Operations resource.", + "canonical": true, + "file": "region_operations.get.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1small.RegionOperations.Get", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1small.Operation", + "client": { + "shortName": "RegionOperationsClient", + "fullName": "google.cloud.compute.v1small.RegionOperationsClient" + }, + "method": { + "shortName": "Get", + "fullName": "google.cloud.compute.v1small.RegionOperations.Get", + "service": { + "shortName": "RegionOperations", + "fullName": "google.cloud.compute.v1small.RegionOperations" + } + } + } + }, + { + "regionTag": "compute_v1small_generated_RegionOperations_Wait_async", + "title": "Addresses wait Sample", + "origin": "API_DEFINITION", + "description": " Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`.", + "canonical": true, + "file": "region_operations.wait.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Wait", + "fullName": "google.cloud.compute.v1small.RegionOperations.Wait", + "async": true, + "parameters": [ + { + "name": "operation", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "region", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.compute.v1small.Operation", + "client": { + "shortName": "RegionOperationsClient", + "fullName": "google.cloud.compute.v1small.RegionOperationsClient" + }, + "method": { + "shortName": "Wait", + "fullName": "google.cloud.compute.v1small.RegionOperations.Wait", + "service": { + "shortName": "RegionOperations", + "fullName": "google.cloud.compute.v1small.RegionOperations" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-compute/src/v1/accelerator_types_client.ts b/packages/google-cloud-compute/src/v1/accelerator_types_client.ts index b825df18bdb9..7764938a1490 100644 --- a/packages/google-cloud-compute/src/v1/accelerator_types_client.ts +++ b/packages/google-cloud-compute/src/v1/accelerator_types_client.ts @@ -342,9 +342,8 @@ export class AcceleratorTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.AcceleratorType | AcceleratorType}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.AcceleratorType|AcceleratorType}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/accelerator_types.get.js * region_tag:compute_v1_generated_AcceleratorTypes_Get_async @@ -449,12 +448,11 @@ export class AcceleratorTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.AcceleratorTypesScopedList | AcceleratorTypesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.AcceleratorTypesScopedList|AcceleratorTypesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/accelerator_types.aggregated_list.js * region_tag:compute_v1_generated_AcceleratorTypes_AggregatedList_async @@ -506,14 +504,13 @@ export class AcceleratorTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.AcceleratorType | AcceleratorType}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.AcceleratorType|AcceleratorType}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -607,13 +604,12 @@ export class AcceleratorTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.AcceleratorType | AcceleratorType} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.AcceleratorType|AcceleratorType} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -662,12 +658,11 @@ export class AcceleratorTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.AcceleratorType | AcceleratorType}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.AcceleratorType|AcceleratorType}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/accelerator_types.list.js * region_tag:compute_v1_generated_AcceleratorTypes_List_async diff --git a/packages/google-cloud-compute/src/v1/addresses_client.ts b/packages/google-cloud-compute/src/v1/addresses_client.ts index 3d60b9fd2d0b..f8720e9477a1 100644 --- a/packages/google-cloud-compute/src/v1/addresses_client.ts +++ b/packages/google-cloud-compute/src/v1/addresses_client.ts @@ -351,8 +351,7 @@ export class AddressesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -465,9 +464,8 @@ export class AddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Address | Address}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Address|Address}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/addresses.get.js * region_tag:compute_v1_generated_Addresses_Get_async @@ -558,8 +556,7 @@ export class AddressesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -677,8 +674,7 @@ export class AddressesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -795,8 +791,7 @@ export class AddressesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -925,12 +920,11 @@ export class AddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.AddressesScopedList | AddressesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.AddressesScopedList|AddressesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/addresses.aggregated_list.js * region_tag:compute_v1_generated_Addresses_AggregatedList_async @@ -982,14 +976,13 @@ export class AddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Address | Address}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Address|Address}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1081,13 +1074,12 @@ export class AddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Address | Address} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Address|Address} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1136,12 +1128,11 @@ export class AddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Address | Address}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Address|Address}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/addresses.list.js * region_tag:compute_v1_generated_Addresses_List_async diff --git a/packages/google-cloud-compute/src/v1/autoscalers_client.ts b/packages/google-cloud-compute/src/v1/autoscalers_client.ts index 747512fa8507..35edd3a553fe 100644 --- a/packages/google-cloud-compute/src/v1/autoscalers_client.ts +++ b/packages/google-cloud-compute/src/v1/autoscalers_client.ts @@ -351,8 +351,7 @@ export class AutoscalersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -471,9 +470,8 @@ export class AutoscalersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Autoscaler | Autoscaler}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Autoscaler|Autoscaler}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/autoscalers.get.js * region_tag:compute_v1_generated_Autoscalers_Get_async @@ -566,8 +564,7 @@ export class AutoscalersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -691,8 +688,7 @@ export class AutoscalersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -810,8 +806,7 @@ export class AutoscalersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -939,12 +934,11 @@ export class AutoscalersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.AutoscalersScopedList | AutoscalersScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.AutoscalersScopedList|AutoscalersScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/autoscalers.aggregated_list.js * region_tag:compute_v1_generated_Autoscalers_AggregatedList_async @@ -996,14 +990,13 @@ export class AutoscalersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Autoscaler | Autoscaler}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Autoscaler|Autoscaler}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1095,13 +1088,12 @@ export class AutoscalersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Autoscaler | Autoscaler} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Autoscaler|Autoscaler} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1150,12 +1142,11 @@ export class AutoscalersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Autoscaler | Autoscaler}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Autoscaler|Autoscaler}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/autoscalers.list.js * region_tag:compute_v1_generated_Autoscalers_List_async diff --git a/packages/google-cloud-compute/src/v1/backend_buckets_client.ts b/packages/google-cloud-compute/src/v1/backend_buckets_client.ts index 5c192d6d56e0..574c88fe5693 100644 --- a/packages/google-cloud-compute/src/v1/backend_buckets_client.ts +++ b/packages/google-cloud-compute/src/v1/backend_buckets_client.ts @@ -348,8 +348,7 @@ export class BackendBucketsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -469,8 +468,7 @@ export class BackendBucketsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -592,8 +590,7 @@ export class BackendBucketsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -709,9 +706,8 @@ export class BackendBucketsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.BackendBucket | BackendBucket}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.BackendBucket|BackendBucket}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/backend_buckets.get.js * region_tag:compute_v1_generated_BackendBuckets_Get_async @@ -807,8 +803,7 @@ export class BackendBucketsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -929,8 +924,7 @@ export class BackendBucketsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1052,8 +1046,7 @@ export class BackendBucketsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1175,8 +1168,7 @@ export class BackendBucketsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1301,14 +1293,13 @@ export class BackendBucketsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.BackendBucket | BackendBucket}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.BackendBucket|BackendBucket}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1397,13 +1388,12 @@ export class BackendBucketsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.BackendBucket | BackendBucket} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.BackendBucket|BackendBucket} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1449,12 +1439,11 @@ export class BackendBucketsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.BackendBucket | BackendBucket}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.BackendBucket|BackendBucket}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/backend_buckets.list.js * region_tag:compute_v1_generated_BackendBuckets_List_async diff --git a/packages/google-cloud-compute/src/v1/backend_services_client.ts b/packages/google-cloud-compute/src/v1/backend_services_client.ts index 7ebaedd7ba7d..e1ba973038e9 100644 --- a/packages/google-cloud-compute/src/v1/backend_services_client.ts +++ b/packages/google-cloud-compute/src/v1/backend_services_client.ts @@ -358,8 +358,7 @@ export class BackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -479,8 +478,7 @@ export class BackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -602,8 +600,7 @@ export class BackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -719,9 +716,8 @@ export class BackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.BackendService | BackendService}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.BackendService|BackendService}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/backend_services.get.js * region_tag:compute_v1_generated_BackendServices_Get_async @@ -814,9 +810,8 @@ export class BackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.BackendServiceGroupHealth | BackendServiceGroupHealth}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.BackendServiceGroupHealth|BackendServiceGroupHealth}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/backend_services.get_health.js * region_tag:compute_v1_generated_BackendServices_GetHealth_async @@ -916,9 +911,8 @@ export class BackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/backend_services.get_iam_policy.js * region_tag:compute_v1_generated_BackendServices_GetIamPolicy_async @@ -1020,8 +1014,7 @@ export class BackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1142,8 +1135,7 @@ export class BackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1265,8 +1257,7 @@ export class BackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1384,9 +1375,8 @@ export class BackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/backend_services.set_iam_policy.js * region_tag:compute_v1_generated_BackendServices_SetIamPolicy_async @@ -1490,8 +1480,7 @@ export class BackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1613,8 +1602,7 @@ export class BackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1742,12 +1730,11 @@ export class BackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.BackendServicesScopedList | BackendServicesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.BackendServicesScopedList|BackendServicesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/backend_services.aggregated_list.js * region_tag:compute_v1_generated_BackendServices_AggregatedList_async @@ -1797,14 +1784,13 @@ export class BackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.BackendService | BackendService}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.BackendService|BackendService}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1893,13 +1879,12 @@ export class BackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.BackendService | BackendService} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.BackendService|BackendService} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1945,12 +1930,11 @@ export class BackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.BackendService | BackendService}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.BackendService|BackendService}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/backend_services.list.js * region_tag:compute_v1_generated_BackendServices_List_async diff --git a/packages/google-cloud-compute/src/v1/disk_types_client.ts b/packages/google-cloud-compute/src/v1/disk_types_client.ts index 7cfc5aad4e00..a5d5f705a73c 100644 --- a/packages/google-cloud-compute/src/v1/disk_types_client.ts +++ b/packages/google-cloud-compute/src/v1/disk_types_client.ts @@ -339,9 +339,8 @@ export class DiskTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.DiskType | DiskType}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.DiskType|DiskType}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/disk_types.get.js * region_tag:compute_v1_generated_DiskTypes_Get_async @@ -438,12 +437,11 @@ export class DiskTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.DiskTypesScopedList | DiskTypesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.DiskTypesScopedList|DiskTypesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/disk_types.aggregated_list.js * region_tag:compute_v1_generated_DiskTypes_AggregatedList_async @@ -495,14 +493,13 @@ export class DiskTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.DiskType | DiskType}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.DiskType|DiskType}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -594,13 +591,12 @@ export class DiskTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.DiskType | DiskType} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.DiskType|DiskType} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -649,12 +645,11 @@ export class DiskTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.DiskType | DiskType}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.DiskType|DiskType}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/disk_types.list.js * region_tag:compute_v1_generated_DiskTypes_List_async diff --git a/packages/google-cloud-compute/src/v1/disks_client.ts b/packages/google-cloud-compute/src/v1/disks_client.ts index 95c72827e13d..9286c0f6f947 100644 --- a/packages/google-cloud-compute/src/v1/disks_client.ts +++ b/packages/google-cloud-compute/src/v1/disks_client.ts @@ -364,8 +364,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -488,8 +487,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -609,8 +607,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -733,8 +730,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -845,9 +841,8 @@ export class DisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Disk | Disk}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Disk|Disk}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/disks.get.js * region_tag:compute_v1_generated_Disks_Get_async @@ -936,9 +931,8 @@ export class DisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/disks.get_iam_policy.js * region_tag:compute_v1_generated_Disks_GetIamPolicy_async @@ -1039,8 +1033,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1156,8 +1149,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1282,8 +1274,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1396,9 +1387,8 @@ export class DisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/disks.set_iam_policy.js * region_tag:compute_v1_generated_Disks_SetIamPolicy_async @@ -1499,8 +1489,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1619,8 +1608,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1743,8 +1731,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1867,8 +1854,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1988,9 +1974,8 @@ export class DisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/disks.test_iam_permissions.js * region_tag:compute_v1_generated_Disks_TestIamPermissions_async @@ -2094,8 +2079,7 @@ export class DisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2216,12 +2200,11 @@ export class DisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.DisksScopedList | DisksScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.DisksScopedList|DisksScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/disks.aggregated_list.js * region_tag:compute_v1_generated_Disks_AggregatedList_async @@ -2271,14 +2254,13 @@ export class DisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Disk | Disk}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Disk|Disk}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -2370,13 +2352,12 @@ export class DisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Disk | Disk} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Disk|Disk} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -2425,12 +2406,11 @@ export class DisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Disk | Disk}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Disk|Disk}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/disks.list.js * region_tag:compute_v1_generated_Disks_List_async diff --git a/packages/google-cloud-compute/src/v1/external_vpn_gateways_client.ts b/packages/google-cloud-compute/src/v1/external_vpn_gateways_client.ts index 533f86fe502b..00c5a2e181b2 100644 --- a/packages/google-cloud-compute/src/v1/external_vpn_gateways_client.ts +++ b/packages/google-cloud-compute/src/v1/external_vpn_gateways_client.ts @@ -343,8 +343,7 @@ export class ExternalVpnGatewaysClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -460,9 +459,8 @@ export class ExternalVpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.ExternalVpnGateway | ExternalVpnGateway}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.ExternalVpnGateway|ExternalVpnGateway}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/external_vpn_gateways.get.js * region_tag:compute_v1_generated_ExternalVpnGateways_Get_async @@ -558,8 +556,7 @@ export class ExternalVpnGatewaysClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -678,8 +675,7 @@ export class ExternalVpnGatewaysClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -797,9 +793,8 @@ export class ExternalVpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/external_vpn_gateways.test_iam_permissions.js * region_tag:compute_v1_generated_ExternalVpnGateways_TestIamPermissions_async @@ -906,14 +901,13 @@ export class ExternalVpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.ExternalVpnGateway | ExternalVpnGateway}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.ExternalVpnGateway|ExternalVpnGateway}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1004,13 +998,12 @@ export class ExternalVpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.ExternalVpnGateway | ExternalVpnGateway} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.ExternalVpnGateway|ExternalVpnGateway} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1056,12 +1049,11 @@ export class ExternalVpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.ExternalVpnGateway | ExternalVpnGateway}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.ExternalVpnGateway|ExternalVpnGateway}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/external_vpn_gateways.list.js * region_tag:compute_v1_generated_ExternalVpnGateways_List_async diff --git a/packages/google-cloud-compute/src/v1/firewall_policies_client.ts b/packages/google-cloud-compute/src/v1/firewall_policies_client.ts index 6b13d3e58031..b72cb8b851af 100644 --- a/packages/google-cloud-compute/src/v1/firewall_policies_client.ts +++ b/packages/google-cloud-compute/src/v1/firewall_policies_client.ts @@ -357,8 +357,7 @@ export class FirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -477,8 +476,7 @@ export class FirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -597,8 +595,7 @@ export class FirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -715,8 +712,7 @@ export class FirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -829,9 +825,8 @@ export class FirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall_policies.get.js * region_tag:compute_v1_generated_FirewallPolicies_Get_async @@ -922,9 +917,8 @@ export class FirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.FirewallPolicyAssociation | FirewallPolicyAssociation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.FirewallPolicyAssociation|FirewallPolicyAssociation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall_policies.get_association.js * region_tag:compute_v1_generated_FirewallPolicies_GetAssociation_async @@ -1021,9 +1015,8 @@ export class FirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall_policies.get_iam_policy.js * region_tag:compute_v1_generated_FirewallPolicies_GetIamPolicy_async @@ -1120,9 +1113,8 @@ export class FirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.FirewallPolicyRule | FirewallPolicyRule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.FirewallPolicyRule|FirewallPolicyRule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall_policies.get_rule.js * region_tag:compute_v1_generated_FirewallPolicies_GetRule_async @@ -1217,8 +1209,7 @@ export class FirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1327,9 +1318,8 @@ export class FirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.FirewallPoliciesListAssociationsResponse | FirewallPoliciesListAssociationsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.FirewallPoliciesListAssociationsResponse|FirewallPoliciesListAssociationsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall_policies.list_associations.js * region_tag:compute_v1_generated_FirewallPolicies_ListAssociations_async @@ -1426,8 +1416,7 @@ export class FirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1546,8 +1535,7 @@ export class FirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1668,8 +1656,7 @@ export class FirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1788,8 +1775,7 @@ export class FirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1908,8 +1894,7 @@ export class FirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2024,9 +2009,8 @@ export class FirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall_policies.set_iam_policy.js * region_tag:compute_v1_generated_FirewallPolicies_SetIamPolicy_async @@ -2123,9 +2107,8 @@ export class FirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall_policies.test_iam_permissions.js * region_tag:compute_v1_generated_FirewallPolicies_TestIamPermissions_async @@ -2231,14 +2214,13 @@ export class FirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -2323,13 +2305,12 @@ export class FirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -2371,12 +2352,11 @@ export class FirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/firewall_policies.list.js * region_tag:compute_v1_generated_FirewallPolicies_List_async diff --git a/packages/google-cloud-compute/src/v1/firewalls_client.ts b/packages/google-cloud-compute/src/v1/firewalls_client.ts index 2d39a891cb3b..390e7465780c 100644 --- a/packages/google-cloud-compute/src/v1/firewalls_client.ts +++ b/packages/google-cloud-compute/src/v1/firewalls_client.ts @@ -343,8 +343,7 @@ export class FirewallsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -454,9 +453,8 @@ export class FirewallsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Firewall | Firewall}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Firewall|Firewall}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/firewalls.get.js * region_tag:compute_v1_generated_Firewalls_Get_async @@ -544,8 +542,7 @@ export class FirewallsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -660,8 +657,7 @@ export class FirewallsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -777,8 +773,7 @@ export class FirewallsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -897,14 +892,13 @@ export class FirewallsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Firewall | Firewall}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Firewall|Firewall}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -993,13 +987,12 @@ export class FirewallsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Firewall | Firewall} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Firewall|Firewall} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1045,12 +1038,11 @@ export class FirewallsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Firewall | Firewall}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Firewall|Firewall}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/firewalls.list.js * region_tag:compute_v1_generated_Firewalls_List_async diff --git a/packages/google-cloud-compute/src/v1/forwarding_rules_client.ts b/packages/google-cloud-compute/src/v1/forwarding_rules_client.ts index 3739cffd12fa..ad5bbbc7eae3 100644 --- a/packages/google-cloud-compute/src/v1/forwarding_rules_client.ts +++ b/packages/google-cloud-compute/src/v1/forwarding_rules_client.ts @@ -352,8 +352,7 @@ export class ForwardingRulesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -472,9 +471,8 @@ export class ForwardingRulesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.ForwardingRule | ForwardingRule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.ForwardingRule|ForwardingRule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/forwarding_rules.get.js * region_tag:compute_v1_generated_ForwardingRules_Get_async @@ -573,8 +571,7 @@ export class ForwardingRulesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -698,8 +695,7 @@ export class ForwardingRulesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -824,8 +820,7 @@ export class ForwardingRulesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -950,8 +945,7 @@ export class ForwardingRulesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1080,12 +1074,11 @@ export class ForwardingRulesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.ForwardingRulesScopedList | ForwardingRulesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.ForwardingRulesScopedList|ForwardingRulesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/forwarding_rules.aggregated_list.js * region_tag:compute_v1_generated_ForwardingRules_AggregatedList_async @@ -1137,14 +1130,13 @@ export class ForwardingRulesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.ForwardingRule | ForwardingRule}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.ForwardingRule|ForwardingRule}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1236,13 +1228,12 @@ export class ForwardingRulesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.ForwardingRule | ForwardingRule} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.ForwardingRule|ForwardingRule} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1291,12 +1282,11 @@ export class ForwardingRulesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.ForwardingRule | ForwardingRule}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.ForwardingRule|ForwardingRule}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/forwarding_rules.list.js * region_tag:compute_v1_generated_ForwardingRules_List_async diff --git a/packages/google-cloud-compute/src/v1/gapic_metadata.json b/packages/google-cloud-compute/src/v1/gapic_metadata.json index 0cfd8bfcc0b2..57ca02d95569 100644 --- a/packages/google-cloud-compute/src/v1/gapic_metadata.json +++ b/packages/google-cloud-compute/src/v1/gapic_metadata.json @@ -6724,6 +6724,11 @@ "insert" ] }, + "Patch": { + "methods": [ + "patch" + ] + }, "SetIamPolicy": { "methods": [ "setIamPolicy" @@ -6773,6 +6778,11 @@ "insert" ] }, + "Patch": { + "methods": [ + "patch" + ] + }, "SetIamPolicy": { "methods": [ "setIamPolicy" diff --git a/packages/google-cloud-compute/src/v1/global_addresses_client.ts b/packages/google-cloud-compute/src/v1/global_addresses_client.ts index 0cf485822e15..fd558fafeea5 100644 --- a/packages/google-cloud-compute/src/v1/global_addresses_client.ts +++ b/packages/google-cloud-compute/src/v1/global_addresses_client.ts @@ -343,8 +343,7 @@ export class GlobalAddressesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -460,9 +459,8 @@ export class GlobalAddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Address | Address}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Address|Address}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/global_addresses.get.js * region_tag:compute_v1_generated_GlobalAddresses_Get_async @@ -558,8 +556,7 @@ export class GlobalAddressesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -680,8 +677,7 @@ export class GlobalAddressesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -801,8 +797,7 @@ export class GlobalAddressesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -927,14 +922,13 @@ export class GlobalAddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Address | Address}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Address|Address}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1023,13 +1017,12 @@ export class GlobalAddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Address | Address} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Address|Address} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1075,12 +1068,11 @@ export class GlobalAddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Address | Address}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Address|Address}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/global_addresses.list.js * region_tag:compute_v1_generated_GlobalAddresses_List_async diff --git a/packages/google-cloud-compute/src/v1/global_forwarding_rules_client.ts b/packages/google-cloud-compute/src/v1/global_forwarding_rules_client.ts index 86fe4aa84f59..60cbb177eacd 100644 --- a/packages/google-cloud-compute/src/v1/global_forwarding_rules_client.ts +++ b/packages/google-cloud-compute/src/v1/global_forwarding_rules_client.ts @@ -345,8 +345,7 @@ export class GlobalForwardingRulesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -462,9 +461,8 @@ export class GlobalForwardingRulesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.ForwardingRule | ForwardingRule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.ForwardingRule|ForwardingRule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/global_forwarding_rules.get.js * region_tag:compute_v1_generated_GlobalForwardingRules_Get_async @@ -566,8 +564,7 @@ export class GlobalForwardingRulesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -688,8 +685,7 @@ export class GlobalForwardingRulesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -809,8 +805,7 @@ export class GlobalForwardingRulesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -932,8 +927,7 @@ export class GlobalForwardingRulesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1058,14 +1052,13 @@ export class GlobalForwardingRulesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.ForwardingRule | ForwardingRule}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.ForwardingRule|ForwardingRule}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1154,13 +1147,12 @@ export class GlobalForwardingRulesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.ForwardingRule | ForwardingRule} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.ForwardingRule|ForwardingRule} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1206,12 +1198,11 @@ export class GlobalForwardingRulesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.ForwardingRule | ForwardingRule}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.ForwardingRule|ForwardingRule}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/global_forwarding_rules.list.js * region_tag:compute_v1_generated_GlobalForwardingRules_List_async diff --git a/packages/google-cloud-compute/src/v1/global_network_endpoint_groups_client.ts b/packages/google-cloud-compute/src/v1/global_network_endpoint_groups_client.ts index 63ed77297291..627a895822a8 100644 --- a/packages/google-cloud-compute/src/v1/global_network_endpoint_groups_client.ts +++ b/packages/google-cloud-compute/src/v1/global_network_endpoint_groups_client.ts @@ -353,8 +353,7 @@ export class GlobalNetworkEndpointGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -474,8 +473,7 @@ export class GlobalNetworkEndpointGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -597,8 +595,7 @@ export class GlobalNetworkEndpointGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -714,9 +711,8 @@ export class GlobalNetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/global_network_endpoint_groups.get.js * region_tag:compute_v1_generated_GlobalNetworkEndpointGroups_Get_async @@ -818,8 +814,7 @@ export class GlobalNetworkEndpointGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -943,14 +938,13 @@ export class GlobalNetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1047,13 +1041,12 @@ export class GlobalNetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1099,12 +1092,11 @@ export class GlobalNetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/global_network_endpoint_groups.list.js * region_tag:compute_v1_generated_GlobalNetworkEndpointGroups_List_async @@ -1152,14 +1144,13 @@ export class GlobalNetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.NetworkEndpointWithHealthStatus | NetworkEndpointWithHealthStatus}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.NetworkEndpointWithHealthStatus|NetworkEndpointWithHealthStatus}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listNetworkEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNetworkEndpoints( @@ -1259,13 +1250,12 @@ export class GlobalNetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.NetworkEndpointWithHealthStatus | NetworkEndpointWithHealthStatus} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.NetworkEndpointWithHealthStatus|NetworkEndpointWithHealthStatus} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listNetworkEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNetworkEndpointsStream( @@ -1314,12 +1304,11 @@ export class GlobalNetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.NetworkEndpointWithHealthStatus | NetworkEndpointWithHealthStatus}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.NetworkEndpointWithHealthStatus|NetworkEndpointWithHealthStatus}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/global_network_endpoint_groups.list_network_endpoints.js * region_tag:compute_v1_generated_GlobalNetworkEndpointGroups_ListNetworkEndpoints_async diff --git a/packages/google-cloud-compute/src/v1/global_operations_client.ts b/packages/google-cloud-compute/src/v1/global_operations_client.ts index 4e29620d1f25..9519e230fbd3 100644 --- a/packages/google-cloud-compute/src/v1/global_operations_client.ts +++ b/packages/google-cloud-compute/src/v1/global_operations_client.ts @@ -342,9 +342,8 @@ export class GlobalOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.DeleteGlobalOperationResponse | DeleteGlobalOperationResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.DeleteGlobalOperationResponse|DeleteGlobalOperationResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/global_operations.delete.js * region_tag:compute_v1_generated_GlobalOperations_Delete_async @@ -436,9 +435,8 @@ export class GlobalOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Operation | Operation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Operation|Operation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/global_operations.get.js * region_tag:compute_v1_generated_GlobalOperations_Get_async @@ -530,9 +528,8 @@ export class GlobalOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Operation | Operation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Operation|Operation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/global_operations.wait.js * region_tag:compute_v1_generated_GlobalOperations_Wait_async @@ -636,12 +633,11 @@ export class GlobalOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.OperationsScopedList | OperationsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.OperationsScopedList|OperationsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/global_operations.aggregated_list.js * region_tag:compute_v1_generated_GlobalOperations_AggregatedList_async @@ -691,14 +687,13 @@ export class GlobalOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Operation | Operation}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Operation|Operation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -787,13 +782,12 @@ export class GlobalOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Operation | Operation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Operation|Operation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -839,12 +833,11 @@ export class GlobalOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Operation | Operation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Operation|Operation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/global_operations.list.js * region_tag:compute_v1_generated_GlobalOperations_List_async diff --git a/packages/google-cloud-compute/src/v1/global_organization_operations_client.ts b/packages/google-cloud-compute/src/v1/global_organization_operations_client.ts index d4a3e559a3dd..7f36616c126f 100644 --- a/packages/google-cloud-compute/src/v1/global_organization_operations_client.ts +++ b/packages/google-cloud-compute/src/v1/global_organization_operations_client.ts @@ -333,9 +333,8 @@ export class GlobalOrganizationOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.DeleteGlobalOrganizationOperationResponse | DeleteGlobalOrganizationOperationResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.DeleteGlobalOrganizationOperationResponse|DeleteGlobalOrganizationOperationResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/global_organization_operations.delete.js * region_tag:compute_v1_generated_GlobalOrganizationOperations_Delete_async @@ -432,9 +431,8 @@ export class GlobalOrganizationOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Operation | Operation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Operation|Operation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/global_organization_operations.get.js * region_tag:compute_v1_generated_GlobalOrganizationOperations_Get_async @@ -540,14 +538,13 @@ export class GlobalOrganizationOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Operation | Operation}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Operation|Operation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -632,13 +629,12 @@ export class GlobalOrganizationOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Operation | Operation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Operation|Operation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -680,12 +676,11 @@ export class GlobalOrganizationOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Operation | Operation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Operation|Operation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/global_organization_operations.list.js * region_tag:compute_v1_generated_GlobalOrganizationOperations_List_async diff --git a/packages/google-cloud-compute/src/v1/global_public_delegated_prefixes_client.ts b/packages/google-cloud-compute/src/v1/global_public_delegated_prefixes_client.ts index 7033e38f8999..db56f6da6efa 100644 --- a/packages/google-cloud-compute/src/v1/global_public_delegated_prefixes_client.ts +++ b/packages/google-cloud-compute/src/v1/global_public_delegated_prefixes_client.ts @@ -344,8 +344,7 @@ export class GlobalPublicDelegatedPrefixesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -461,9 +460,8 @@ export class GlobalPublicDelegatedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.PublicDelegatedPrefix | PublicDelegatedPrefix}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.PublicDelegatedPrefix|PublicDelegatedPrefix}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/global_public_delegated_prefixes.get.js * region_tag:compute_v1_generated_GlobalPublicDelegatedPrefixes_Get_async @@ -565,8 +563,7 @@ export class GlobalPublicDelegatedPrefixesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -687,8 +684,7 @@ export class GlobalPublicDelegatedPrefixesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -813,14 +809,13 @@ export class GlobalPublicDelegatedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.PublicDelegatedPrefix | PublicDelegatedPrefix}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.PublicDelegatedPrefix|PublicDelegatedPrefix}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -917,13 +912,12 @@ export class GlobalPublicDelegatedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.PublicDelegatedPrefix | PublicDelegatedPrefix} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.PublicDelegatedPrefix|PublicDelegatedPrefix} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -969,12 +963,11 @@ export class GlobalPublicDelegatedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.PublicDelegatedPrefix | PublicDelegatedPrefix}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.PublicDelegatedPrefix|PublicDelegatedPrefix}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/global_public_delegated_prefixes.list.js * region_tag:compute_v1_generated_GlobalPublicDelegatedPrefixes_List_async diff --git a/packages/google-cloud-compute/src/v1/health_checks_client.ts b/packages/google-cloud-compute/src/v1/health_checks_client.ts index 37b2553c8bea..11dbbfb8477c 100644 --- a/packages/google-cloud-compute/src/v1/health_checks_client.ts +++ b/packages/google-cloud-compute/src/v1/health_checks_client.ts @@ -349,8 +349,7 @@ export class HealthChecksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -466,9 +465,8 @@ export class HealthChecksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.HealthCheck | HealthCheck}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.HealthCheck|HealthCheck}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/health_checks.get.js * region_tag:compute_v1_generated_HealthChecks_Get_async @@ -558,8 +556,7 @@ export class HealthChecksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -680,8 +677,7 @@ export class HealthChecksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -803,8 +799,7 @@ export class HealthChecksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -932,12 +927,11 @@ export class HealthChecksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.HealthChecksScopedList | HealthChecksScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.HealthChecksScopedList|HealthChecksScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/health_checks.aggregated_list.js * region_tag:compute_v1_generated_HealthChecks_AggregatedList_async @@ -987,14 +981,13 @@ export class HealthChecksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.HealthCheck | HealthCheck}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.HealthCheck|HealthCheck}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1083,13 +1076,12 @@ export class HealthChecksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.HealthCheck | HealthCheck} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.HealthCheck|HealthCheck} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1135,12 +1127,11 @@ export class HealthChecksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.HealthCheck | HealthCheck}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.HealthCheck|HealthCheck}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/health_checks.list.js * region_tag:compute_v1_generated_HealthChecks_List_async diff --git a/packages/google-cloud-compute/src/v1/image_family_views_client.ts b/packages/google-cloud-compute/src/v1/image_family_views_client.ts index c3f22d58c6c9..4e8dbd7394da 100644 --- a/packages/google-cloud-compute/src/v1/image_family_views_client.ts +++ b/packages/google-cloud-compute/src/v1/image_family_views_client.ts @@ -321,9 +321,8 @@ export class ImageFamilyViewsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.ImageFamilyView | ImageFamilyView}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.ImageFamilyView|ImageFamilyView}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/image_family_views.get.js * region_tag:compute_v1_generated_ImageFamilyViews_Get_async diff --git a/packages/google-cloud-compute/src/v1/images_client.ts b/packages/google-cloud-compute/src/v1/images_client.ts index b62a42564e6d..5448c2578cb7 100644 --- a/packages/google-cloud-compute/src/v1/images_client.ts +++ b/packages/google-cloud-compute/src/v1/images_client.ts @@ -348,8 +348,7 @@ export class ImagesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -463,8 +462,7 @@ export class ImagesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -574,9 +572,8 @@ export class ImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Image | Image}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Image|Image}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/images.get.js * region_tag:compute_v1_generated_Images_Get_async @@ -660,9 +657,8 @@ export class ImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Image | Image}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Image|Image}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/images.get_from_family.js * region_tag:compute_v1_generated_Images_GetFromFamily_async @@ -756,9 +752,8 @@ export class ImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/images.get_iam_policy.js * region_tag:compute_v1_generated_Images_GetIamPolicy_async @@ -856,8 +851,7 @@ export class ImagesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -970,8 +964,7 @@ export class ImagesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1081,9 +1074,8 @@ export class ImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/images.set_iam_policy.js * region_tag:compute_v1_generated_Images_SetIamPolicy_async @@ -1179,8 +1171,7 @@ export class ImagesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1292,9 +1283,8 @@ export class ImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/images.test_iam_permissions.js * region_tag:compute_v1_generated_Images_TestIamPermissions_async @@ -1401,14 +1391,13 @@ export class ImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Image | Image}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Image|Image}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1497,13 +1486,12 @@ export class ImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Image | Image} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Image|Image} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1549,12 +1537,11 @@ export class ImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Image | Image}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Image|Image}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/images.list.js * region_tag:compute_v1_generated_Images_List_async diff --git a/packages/google-cloud-compute/src/v1/instance_group_managers_client.ts b/packages/google-cloud-compute/src/v1/instance_group_managers_client.ts index ccb3b30528d1..cf991b76f027 100644 --- a/packages/google-cloud-compute/src/v1/instance_group_managers_client.ts +++ b/packages/google-cloud-compute/src/v1/instance_group_managers_client.ts @@ -382,8 +382,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -506,8 +505,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -632,8 +630,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -756,8 +753,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -882,8 +878,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1006,8 +1001,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1126,9 +1120,8 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.InstanceGroupManager | InstanceGroupManager}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.InstanceGroupManager|InstanceGroupManager}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_group_managers.get.js * region_tag:compute_v1_generated_InstanceGroupManagers_Get_async @@ -1233,8 +1226,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1358,8 +1350,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1484,8 +1475,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1610,8 +1600,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1736,8 +1725,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1862,8 +1850,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1988,8 +1975,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2114,8 +2100,7 @@ export class InstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2244,12 +2229,11 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.InstanceGroupManagersScopedList | InstanceGroupManagersScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.InstanceGroupManagersScopedList|InstanceGroupManagersScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_group_managers.aggregated_list.js * region_tag:compute_v1_generated_InstanceGroupManagers_AggregatedList_async @@ -2301,14 +2285,13 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InstanceGroupManager | InstanceGroupManager}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InstanceGroupManager|InstanceGroupManager}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -2408,13 +2391,12 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InstanceGroupManager | InstanceGroupManager} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceGroupManager|InstanceGroupManager} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -2463,12 +2445,11 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InstanceGroupManager | InstanceGroupManager}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InstanceGroupManager|InstanceGroupManager}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_group_managers.list.js * region_tag:compute_v1_generated_InstanceGroupManagers_List_async @@ -2519,14 +2500,13 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InstanceManagedByIgmError | InstanceManagedByIgmError}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InstanceManagedByIgmError|InstanceManagedByIgmError}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listErrorsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listErrors( @@ -2629,13 +2609,12 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InstanceManagedByIgmError | InstanceManagedByIgmError} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceManagedByIgmError|InstanceManagedByIgmError} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listErrorsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listErrorsStream( @@ -2687,12 +2666,11 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InstanceManagedByIgmError | InstanceManagedByIgmError}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InstanceManagedByIgmError|InstanceManagedByIgmError}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_group_managers.list_errors.js * region_tag:compute_v1_generated_InstanceGroupManagers_ListErrors_async @@ -2744,14 +2722,13 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.ManagedInstance | ManagedInstance}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.ManagedInstance|ManagedInstance}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listManagedInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listManagedInstances( @@ -2854,13 +2831,12 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.ManagedInstance | ManagedInstance} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.ManagedInstance|ManagedInstance} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listManagedInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listManagedInstancesStream( @@ -2912,12 +2888,11 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.ManagedInstance | ManagedInstance}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.ManagedInstance|ManagedInstance}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_group_managers.list_managed_instances.js * region_tag:compute_v1_generated_InstanceGroupManagers_ListManagedInstances_async @@ -2969,14 +2944,13 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.PerInstanceConfig | PerInstanceConfig}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.PerInstanceConfig|PerInstanceConfig}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listPerInstanceConfigsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPerInstanceConfigs( @@ -3083,13 +3057,12 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.PerInstanceConfig | PerInstanceConfig} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.PerInstanceConfig|PerInstanceConfig} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listPerInstanceConfigsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPerInstanceConfigsStream( @@ -3141,12 +3114,11 @@ export class InstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.PerInstanceConfig | PerInstanceConfig}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.PerInstanceConfig|PerInstanceConfig}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_group_managers.list_per_instance_configs.js * region_tag:compute_v1_generated_InstanceGroupManagers_ListPerInstanceConfigs_async diff --git a/packages/google-cloud-compute/src/v1/instance_groups_client.ts b/packages/google-cloud-compute/src/v1/instance_groups_client.ts index cb1a6fbd2953..5ac8dc08a15f 100644 --- a/packages/google-cloud-compute/src/v1/instance_groups_client.ts +++ b/packages/google-cloud-compute/src/v1/instance_groups_client.ts @@ -360,8 +360,7 @@ export class InstanceGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -484,8 +483,7 @@ export class InstanceGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -604,9 +602,8 @@ export class InstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.InstanceGroup | InstanceGroup}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.InstanceGroup|InstanceGroup}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_groups.get.js * region_tag:compute_v1_generated_InstanceGroups_Get_async @@ -705,8 +702,7 @@ export class InstanceGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -830,8 +826,7 @@ export class InstanceGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -956,8 +951,7 @@ export class InstanceGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1086,12 +1080,11 @@ export class InstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.InstanceGroupsScopedList | InstanceGroupsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.InstanceGroupsScopedList|InstanceGroupsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_groups.aggregated_list.js * region_tag:compute_v1_generated_InstanceGroups_AggregatedList_async @@ -1143,14 +1136,13 @@ export class InstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InstanceGroup | InstanceGroup}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InstanceGroup|InstanceGroup}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1242,13 +1234,12 @@ export class InstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InstanceGroup | InstanceGroup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceGroup|InstanceGroup} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1297,12 +1288,11 @@ export class InstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InstanceGroup | InstanceGroup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InstanceGroup|InstanceGroup}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_groups.list.js * region_tag:compute_v1_generated_InstanceGroups_List_async @@ -1355,14 +1345,13 @@ export class InstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InstanceWithNamedPorts | InstanceWithNamedPorts}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InstanceWithNamedPorts|InstanceWithNamedPorts}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstances( @@ -1467,13 +1456,12 @@ export class InstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InstanceWithNamedPorts | InstanceWithNamedPorts} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceWithNamedPorts|InstanceWithNamedPorts} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstancesStream( @@ -1527,12 +1515,11 @@ export class InstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InstanceWithNamedPorts | InstanceWithNamedPorts}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InstanceWithNamedPorts|InstanceWithNamedPorts}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_groups.list_instances.js * region_tag:compute_v1_generated_InstanceGroups_ListInstances_async diff --git a/packages/google-cloud-compute/src/v1/instance_templates_client.ts b/packages/google-cloud-compute/src/v1/instance_templates_client.ts index 361d2d7009fa..3d2aaff4aa2c 100644 --- a/packages/google-cloud-compute/src/v1/instance_templates_client.ts +++ b/packages/google-cloud-compute/src/v1/instance_templates_client.ts @@ -350,8 +350,7 @@ export class InstanceTemplatesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -467,9 +466,8 @@ export class InstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.InstanceTemplate | InstanceTemplate}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.InstanceTemplate|InstanceTemplate}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_templates.get.js * region_tag:compute_v1_generated_InstanceTemplates_Get_async @@ -563,9 +561,8 @@ export class InstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_templates.get_iam_policy.js * region_tag:compute_v1_generated_InstanceTemplates_GetIamPolicy_async @@ -667,8 +664,7 @@ export class InstanceTemplatesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -785,9 +781,8 @@ export class InstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_templates.set_iam_policy.js * region_tag:compute_v1_generated_InstanceTemplates_SetIamPolicy_async @@ -887,9 +882,8 @@ export class InstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_templates.test_iam_permissions.js * region_tag:compute_v1_generated_InstanceTemplates_TestIamPermissions_async @@ -999,12 +993,11 @@ export class InstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.InstanceTemplatesScopedList | InstanceTemplatesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.InstanceTemplatesScopedList|InstanceTemplatesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_templates.aggregated_list.js * region_tag:compute_v1_generated_InstanceTemplates_AggregatedList_async @@ -1054,14 +1047,13 @@ export class InstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InstanceTemplate | InstanceTemplate}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InstanceTemplate|InstanceTemplate}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1152,13 +1144,12 @@ export class InstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InstanceTemplate | InstanceTemplate} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceTemplate|InstanceTemplate} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1204,12 +1195,11 @@ export class InstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InstanceTemplate | InstanceTemplate}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InstanceTemplate|InstanceTemplate}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instance_templates.list.js * region_tag:compute_v1_generated_InstanceTemplates_List_async diff --git a/packages/google-cloud-compute/src/v1/instances_client.ts b/packages/google-cloud-compute/src/v1/instances_client.ts index a354b54905ea..7f1d0a343074 100644 --- a/packages/google-cloud-compute/src/v1/instances_client.ts +++ b/packages/google-cloud-compute/src/v1/instances_client.ts @@ -399,8 +399,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -525,8 +524,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -653,8 +651,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -777,8 +774,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -900,8 +896,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1022,8 +1017,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1148,8 +1142,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1268,9 +1261,8 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Instance | Instance}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Instance|Instance}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.get.js * region_tag:compute_v1_generated_Instances_Get_async @@ -1359,9 +1351,8 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.InstancesGetEffectiveFirewallsResponse | InstancesGetEffectiveFirewallsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.InstancesGetEffectiveFirewallsResponse|InstancesGetEffectiveFirewallsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.get_effective_firewalls.js * region_tag:compute_v1_generated_Instances_GetEffectiveFirewalls_async @@ -1466,9 +1457,8 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.GuestAttributes | GuestAttributes}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.GuestAttributes|GuestAttributes}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.get_guest_attributes.js * region_tag:compute_v1_generated_Instances_GetGuestAttributes_async @@ -1571,9 +1561,8 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.get_iam_policy.js * region_tag:compute_v1_generated_Instances_GetIamPolicy_async @@ -1668,9 +1657,8 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Screenshot | Screenshot}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Screenshot|Screenshot}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.get_screenshot.js * region_tag:compute_v1_generated_Instances_GetScreenshot_async @@ -1769,9 +1757,8 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SerialPortOutput | SerialPortOutput}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SerialPortOutput|SerialPortOutput}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.get_serial_port_output.js * region_tag:compute_v1_generated_Instances_GetSerialPortOutput_async @@ -1872,9 +1859,8 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.ShieldedInstanceIdentity | ShieldedInstanceIdentity}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.ShieldedInstanceIdentity|ShieldedInstanceIdentity}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.get_shielded_instance_identity.js * region_tag:compute_v1_generated_Instances_GetShieldedInstanceIdentity_async @@ -1987,8 +1973,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2106,8 +2091,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2230,8 +2214,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2348,8 +2331,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2462,9 +2444,8 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SendDiagnosticInterruptInstanceResponse | SendDiagnosticInterruptInstanceResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SendDiagnosticInterruptInstanceResponse|SendDiagnosticInterruptInstanceResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.send_diagnostic_interrupt.js * region_tag:compute_v1_generated_Instances_SendDiagnosticInterrupt_async @@ -2575,8 +2556,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2703,8 +2683,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2825,9 +2804,8 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.set_iam_policy.js * region_tag:compute_v1_generated_Instances_SetIamPolicy_async @@ -2928,8 +2906,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -3054,8 +3031,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -3180,8 +3156,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -3306,8 +3281,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -3432,8 +3406,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -3558,8 +3531,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -3678,8 +3650,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -3804,8 +3775,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -3930,8 +3900,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -4056,8 +4025,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -4174,8 +4142,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -4298,8 +4265,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -4418,8 +4384,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -4544,8 +4509,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -4664,8 +4628,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -4780,9 +4743,8 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.test_iam_permissions.js * region_tag:compute_v1_generated_Instances_TestIamPermissions_async @@ -4895,8 +4857,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -5017,8 +4978,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -5143,8 +5103,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -5271,8 +5230,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -5397,8 +5355,7 @@ export class InstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -5527,12 +5484,11 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.InstancesScopedList | InstancesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.InstancesScopedList|InstancesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.aggregated_list.js * region_tag:compute_v1_generated_Instances_AggregatedList_async @@ -5584,14 +5540,13 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Instance | Instance}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Instance|Instance}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -5683,13 +5638,12 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Instance | Instance} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Instance|Instance} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -5738,12 +5692,11 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Instance | Instance}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Instance|Instance}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.list.js * region_tag:compute_v1_generated_Instances_List_async @@ -5794,14 +5747,13 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Reference | Reference}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Reference|Reference}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listReferrersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listReferrers( @@ -5898,13 +5850,12 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Reference | Reference} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Reference|Reference} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listReferrersAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listReferrersStream( @@ -5956,12 +5907,11 @@ export class InstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Reference | Reference}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Reference|Reference}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/instances.list_referrers.js * region_tag:compute_v1_generated_Instances_ListReferrers_async diff --git a/packages/google-cloud-compute/src/v1/interconnect_attachments_client.ts b/packages/google-cloud-compute/src/v1/interconnect_attachments_client.ts index 5baf525d58e6..219cb0ced5e7 100644 --- a/packages/google-cloud-compute/src/v1/interconnect_attachments_client.ts +++ b/packages/google-cloud-compute/src/v1/interconnect_attachments_client.ts @@ -352,8 +352,7 @@ export class InterconnectAttachmentsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -472,9 +471,8 @@ export class InterconnectAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.InterconnectAttachment | InterconnectAttachment}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.InterconnectAttachment|InterconnectAttachment}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/interconnect_attachments.get.js * region_tag:compute_v1_generated_InterconnectAttachments_Get_async @@ -581,8 +579,7 @@ export class InterconnectAttachmentsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -706,8 +703,7 @@ export class InterconnectAttachmentsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -832,8 +828,7 @@ export class InterconnectAttachmentsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -962,12 +957,11 @@ export class InterconnectAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.InterconnectAttachmentsScopedList | InterconnectAttachmentsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.InterconnectAttachmentsScopedList|InterconnectAttachmentsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/interconnect_attachments.aggregated_list.js * region_tag:compute_v1_generated_InterconnectAttachments_AggregatedList_async @@ -1022,14 +1016,13 @@ export class InterconnectAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InterconnectAttachment | InterconnectAttachment}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InterconnectAttachment|InterconnectAttachment}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1129,13 +1122,12 @@ export class InterconnectAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InterconnectAttachment | InterconnectAttachment} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InterconnectAttachment|InterconnectAttachment} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1184,12 +1176,11 @@ export class InterconnectAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InterconnectAttachment | InterconnectAttachment}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InterconnectAttachment|InterconnectAttachment}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/interconnect_attachments.list.js * region_tag:compute_v1_generated_InterconnectAttachments_List_async diff --git a/packages/google-cloud-compute/src/v1/interconnect_locations_client.ts b/packages/google-cloud-compute/src/v1/interconnect_locations_client.ts index 67723eddc622..143d005cba96 100644 --- a/packages/google-cloud-compute/src/v1/interconnect_locations_client.ts +++ b/packages/google-cloud-compute/src/v1/interconnect_locations_client.ts @@ -333,9 +333,8 @@ export class InterconnectLocationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.InterconnectLocation | InterconnectLocation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.InterconnectLocation|InterconnectLocation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/interconnect_locations.get.js * region_tag:compute_v1_generated_InterconnectLocations_Get_async @@ -442,14 +441,13 @@ export class InterconnectLocationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InterconnectLocation | InterconnectLocation}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InterconnectLocation|InterconnectLocation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -546,13 +544,12 @@ export class InterconnectLocationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InterconnectLocation | InterconnectLocation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InterconnectLocation|InterconnectLocation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -598,12 +595,11 @@ export class InterconnectLocationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InterconnectLocation | InterconnectLocation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InterconnectLocation|InterconnectLocation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/interconnect_locations.list.js * region_tag:compute_v1_generated_InterconnectLocations_List_async diff --git a/packages/google-cloud-compute/src/v1/interconnect_remote_locations_client.ts b/packages/google-cloud-compute/src/v1/interconnect_remote_locations_client.ts index df4db7e270ec..96582ae206bf 100644 --- a/packages/google-cloud-compute/src/v1/interconnect_remote_locations_client.ts +++ b/packages/google-cloud-compute/src/v1/interconnect_remote_locations_client.ts @@ -334,9 +334,8 @@ export class InterconnectRemoteLocationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.InterconnectRemoteLocation | InterconnectRemoteLocation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.InterconnectRemoteLocation|InterconnectRemoteLocation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/interconnect_remote_locations.get.js * region_tag:compute_v1_generated_InterconnectRemoteLocations_Get_async @@ -443,14 +442,13 @@ export class InterconnectRemoteLocationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InterconnectRemoteLocation | InterconnectRemoteLocation}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InterconnectRemoteLocation|InterconnectRemoteLocation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -547,13 +545,12 @@ export class InterconnectRemoteLocationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InterconnectRemoteLocation | InterconnectRemoteLocation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InterconnectRemoteLocation|InterconnectRemoteLocation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -599,12 +596,11 @@ export class InterconnectRemoteLocationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InterconnectRemoteLocation | InterconnectRemoteLocation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InterconnectRemoteLocation|InterconnectRemoteLocation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/interconnect_remote_locations.list.js * region_tag:compute_v1_generated_InterconnectRemoteLocations_List_async diff --git a/packages/google-cloud-compute/src/v1/interconnects_client.ts b/packages/google-cloud-compute/src/v1/interconnects_client.ts index 2ea4184094f3..7f44ea2d4961 100644 --- a/packages/google-cloud-compute/src/v1/interconnects_client.ts +++ b/packages/google-cloud-compute/src/v1/interconnects_client.ts @@ -344,8 +344,7 @@ export class InterconnectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -461,9 +460,8 @@ export class InterconnectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Interconnect | Interconnect}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Interconnect|Interconnect}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/interconnects.get.js * region_tag:compute_v1_generated_Interconnects_Get_async @@ -549,9 +547,8 @@ export class InterconnectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.InterconnectsGetDiagnosticsResponse | InterconnectsGetDiagnosticsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.InterconnectsGetDiagnosticsResponse|InterconnectsGetDiagnosticsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/interconnects.get_diagnostics.js * region_tag:compute_v1_generated_Interconnects_GetDiagnostics_async @@ -653,8 +650,7 @@ export class InterconnectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -775,8 +771,7 @@ export class InterconnectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -896,8 +891,7 @@ export class InterconnectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1022,14 +1016,13 @@ export class InterconnectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Interconnect | Interconnect}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Interconnect|Interconnect}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1118,13 +1111,12 @@ export class InterconnectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Interconnect | Interconnect} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Interconnect|Interconnect} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1170,12 +1162,11 @@ export class InterconnectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Interconnect | Interconnect}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Interconnect|Interconnect}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/interconnects.list.js * region_tag:compute_v1_generated_Interconnects_List_async diff --git a/packages/google-cloud-compute/src/v1/license_codes_client.ts b/packages/google-cloud-compute/src/v1/license_codes_client.ts index c984daa7c43b..5cdf434d59ac 100644 --- a/packages/google-cloud-compute/src/v1/license_codes_client.ts +++ b/packages/google-cloud-compute/src/v1/license_codes_client.ts @@ -319,9 +319,8 @@ export class LicenseCodesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.LicenseCode | LicenseCode}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.LicenseCode|LicenseCode}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/license_codes.get.js * region_tag:compute_v1_generated_LicenseCodes_Get_async @@ -409,9 +408,8 @@ export class LicenseCodesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/license_codes.test_iam_permissions.js * region_tag:compute_v1_generated_LicenseCodes_TestIamPermissions_async diff --git a/packages/google-cloud-compute/src/v1/licenses_client.ts b/packages/google-cloud-compute/src/v1/licenses_client.ts index 6cfa9b353974..23e9e8f842c8 100644 --- a/packages/google-cloud-compute/src/v1/licenses_client.ts +++ b/packages/google-cloud-compute/src/v1/licenses_client.ts @@ -344,8 +344,7 @@ export class LicensesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -455,9 +454,8 @@ export class LicensesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.License | License}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.License|License}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/licenses.get.js * region_tag:compute_v1_generated_Licenses_Get_async @@ -543,9 +541,8 @@ export class LicensesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/licenses.get_iam_policy.js * region_tag:compute_v1_generated_Licenses_GetIamPolicy_async @@ -641,8 +638,7 @@ export class LicensesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -753,9 +749,8 @@ export class LicensesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/licenses.set_iam_policy.js * region_tag:compute_v1_generated_Licenses_SetIamPolicy_async @@ -849,9 +844,8 @@ export class LicensesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/licenses.test_iam_permissions.js * region_tag:compute_v1_generated_Licenses_TestIamPermissions_async @@ -958,14 +952,13 @@ export class LicensesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.License | License}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.License|License}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1056,13 +1049,12 @@ export class LicensesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.License | License} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.License|License} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1108,12 +1100,11 @@ export class LicensesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.License | License}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.License|License}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/licenses.list.js * region_tag:compute_v1_generated_Licenses_List_async diff --git a/packages/google-cloud-compute/src/v1/machine_images_client.ts b/packages/google-cloud-compute/src/v1/machine_images_client.ts index 65d575b1862e..56509c3c416a 100644 --- a/packages/google-cloud-compute/src/v1/machine_images_client.ts +++ b/packages/google-cloud-compute/src/v1/machine_images_client.ts @@ -344,8 +344,7 @@ export class MachineImagesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -461,9 +460,8 @@ export class MachineImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.MachineImage | MachineImage}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.MachineImage|MachineImage}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/machine_images.get.js * region_tag:compute_v1_generated_MachineImages_Get_async @@ -551,9 +549,8 @@ export class MachineImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/machine_images.get_iam_policy.js * region_tag:compute_v1_generated_MachineImages_GetIamPolicy_async @@ -657,8 +654,7 @@ export class MachineImagesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -775,9 +771,8 @@ export class MachineImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/machine_images.set_iam_policy.js * region_tag:compute_v1_generated_MachineImages_SetIamPolicy_async @@ -877,9 +872,8 @@ export class MachineImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/machine_images.test_iam_permissions.js * region_tag:compute_v1_generated_MachineImages_TestIamPermissions_async @@ -986,14 +980,13 @@ export class MachineImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.MachineImage | MachineImage}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.MachineImage|MachineImage}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1082,13 +1075,12 @@ export class MachineImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.MachineImage | MachineImage} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.MachineImage|MachineImage} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1134,12 +1126,11 @@ export class MachineImagesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.MachineImage | MachineImage}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.MachineImage|MachineImage}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/machine_images.list.js * region_tag:compute_v1_generated_MachineImages_List_async diff --git a/packages/google-cloud-compute/src/v1/machine_types_client.ts b/packages/google-cloud-compute/src/v1/machine_types_client.ts index 111ec557dbb5..f5bde7bc51f5 100644 --- a/packages/google-cloud-compute/src/v1/machine_types_client.ts +++ b/packages/google-cloud-compute/src/v1/machine_types_client.ts @@ -339,9 +339,8 @@ export class MachineTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.MachineType | MachineType}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.MachineType|MachineType}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/machine_types.get.js * region_tag:compute_v1_generated_MachineTypes_Get_async @@ -440,12 +439,11 @@ export class MachineTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.MachineTypesScopedList | MachineTypesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.MachineTypesScopedList|MachineTypesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/machine_types.aggregated_list.js * region_tag:compute_v1_generated_MachineTypes_AggregatedList_async @@ -497,14 +495,13 @@ export class MachineTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.MachineType | MachineType}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.MachineType|MachineType}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -596,13 +593,12 @@ export class MachineTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.MachineType | MachineType} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.MachineType|MachineType} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -651,12 +647,11 @@ export class MachineTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.MachineType | MachineType}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.MachineType|MachineType}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/machine_types.list.js * region_tag:compute_v1_generated_MachineTypes_List_async diff --git a/packages/google-cloud-compute/src/v1/network_attachments_client.ts b/packages/google-cloud-compute/src/v1/network_attachments_client.ts index 29f8ddad50fa..e717db6424a2 100644 --- a/packages/google-cloud-compute/src/v1/network_attachments_client.ts +++ b/packages/google-cloud-compute/src/v1/network_attachments_client.ts @@ -352,8 +352,7 @@ export class NetworkAttachmentsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -472,9 +471,8 @@ export class NetworkAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.NetworkAttachment | NetworkAttachment}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.NetworkAttachment|NetworkAttachment}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_attachments.get.js * region_tag:compute_v1_generated_NetworkAttachments_Get_async @@ -571,9 +569,8 @@ export class NetworkAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_attachments.get_iam_policy.js * region_tag:compute_v1_generated_NetworkAttachments_GetIamPolicy_async @@ -678,8 +675,7 @@ export class NetworkAttachmentsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -799,9 +795,8 @@ export class NetworkAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_attachments.set_iam_policy.js * region_tag:compute_v1_generated_NetworkAttachments_SetIamPolicy_async @@ -904,9 +899,8 @@ export class NetworkAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_attachments.test_iam_permissions.js * region_tag:compute_v1_generated_NetworkAttachments_TestIamPermissions_async @@ -1017,12 +1011,11 @@ export class NetworkAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.NetworkAttachmentsScopedList | NetworkAttachmentsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.NetworkAttachmentsScopedList|NetworkAttachmentsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/network_attachments.aggregated_list.js * region_tag:compute_v1_generated_NetworkAttachments_AggregatedList_async @@ -1074,14 +1067,13 @@ export class NetworkAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.NetworkAttachment | NetworkAttachment}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.NetworkAttachment|NetworkAttachment}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1175,13 +1167,12 @@ export class NetworkAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.NetworkAttachment | NetworkAttachment} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.NetworkAttachment|NetworkAttachment} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1230,12 +1221,11 @@ export class NetworkAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.NetworkAttachment | NetworkAttachment}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.NetworkAttachment|NetworkAttachment}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/network_attachments.list.js * region_tag:compute_v1_generated_NetworkAttachments_List_async diff --git a/packages/google-cloud-compute/src/v1/network_edge_security_services_client.ts b/packages/google-cloud-compute/src/v1/network_edge_security_services_client.ts index 9a5361494f27..3156489ed862 100644 --- a/packages/google-cloud-compute/src/v1/network_edge_security_services_client.ts +++ b/packages/google-cloud-compute/src/v1/network_edge_security_services_client.ts @@ -346,8 +346,7 @@ export class NetworkEdgeSecurityServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -466,9 +465,8 @@ export class NetworkEdgeSecurityServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.NetworkEdgeSecurityService | NetworkEdgeSecurityService}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.NetworkEdgeSecurityService|NetworkEdgeSecurityService}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_edge_security_services.get.js * region_tag:compute_v1_generated_NetworkEdgeSecurityServices_Get_async @@ -575,8 +573,7 @@ export class NetworkEdgeSecurityServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -703,8 +700,7 @@ export class NetworkEdgeSecurityServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -833,12 +829,11 @@ export class NetworkEdgeSecurityServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.NetworkEdgeSecurityServicesScopedList | NetworkEdgeSecurityServicesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.NetworkEdgeSecurityServicesScopedList|NetworkEdgeSecurityServicesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/network_edge_security_services.aggregated_list.js * region_tag:compute_v1_generated_NetworkEdgeSecurityServices_AggregatedList_async diff --git a/packages/google-cloud-compute/src/v1/network_endpoint_groups_client.ts b/packages/google-cloud-compute/src/v1/network_endpoint_groups_client.ts index be4fbe1f5bf8..cd4d5f7dc325 100644 --- a/packages/google-cloud-compute/src/v1/network_endpoint_groups_client.ts +++ b/packages/google-cloud-compute/src/v1/network_endpoint_groups_client.ts @@ -361,8 +361,7 @@ export class NetworkEndpointGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -485,8 +484,7 @@ export class NetworkEndpointGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -611,8 +609,7 @@ export class NetworkEndpointGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -731,9 +728,8 @@ export class NetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_endpoint_groups.get.js * region_tag:compute_v1_generated_NetworkEndpointGroups_Get_async @@ -838,8 +834,7 @@ export class NetworkEndpointGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -959,9 +954,8 @@ export class NetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_endpoint_groups.test_iam_permissions.js * region_tag:compute_v1_generated_NetworkEndpointGroups_TestIamPermissions_async @@ -1072,12 +1066,11 @@ export class NetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.NetworkEndpointGroupsScopedList | NetworkEndpointGroupsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.NetworkEndpointGroupsScopedList|NetworkEndpointGroupsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/network_endpoint_groups.aggregated_list.js * region_tag:compute_v1_generated_NetworkEndpointGroups_AggregatedList_async @@ -1129,14 +1122,13 @@ export class NetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1236,13 +1228,12 @@ export class NetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1291,12 +1282,11 @@ export class NetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/network_endpoint_groups.list.js * region_tag:compute_v1_generated_NetworkEndpointGroups_List_async @@ -1349,14 +1339,13 @@ export class NetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.NetworkEndpointWithHealthStatus | NetworkEndpointWithHealthStatus}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.NetworkEndpointWithHealthStatus|NetworkEndpointWithHealthStatus}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listNetworkEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNetworkEndpoints( @@ -1461,13 +1450,12 @@ export class NetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.NetworkEndpointWithHealthStatus | NetworkEndpointWithHealthStatus} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.NetworkEndpointWithHealthStatus|NetworkEndpointWithHealthStatus} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listNetworkEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNetworkEndpointsStream( @@ -1521,12 +1509,11 @@ export class NetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.NetworkEndpointWithHealthStatus | NetworkEndpointWithHealthStatus}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.NetworkEndpointWithHealthStatus|NetworkEndpointWithHealthStatus}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/network_endpoint_groups.list_network_endpoints.js * region_tag:compute_v1_generated_NetworkEndpointGroups_ListNetworkEndpoints_async diff --git a/packages/google-cloud-compute/src/v1/network_firewall_policies_client.ts b/packages/google-cloud-compute/src/v1/network_firewall_policies_client.ts index 19ec8aca6a02..f65e0762a721 100644 --- a/packages/google-cloud-compute/src/v1/network_firewall_policies_client.ts +++ b/packages/google-cloud-compute/src/v1/network_firewall_policies_client.ts @@ -358,8 +358,7 @@ export class NetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -485,8 +484,7 @@ export class NetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -608,8 +606,7 @@ export class NetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -729,8 +726,7 @@ export class NetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -846,9 +842,8 @@ export class NetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_firewall_policies.get.js * region_tag:compute_v1_generated_NetworkFirewallPolicies_Get_async @@ -948,9 +943,8 @@ export class NetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.FirewallPolicyAssociation | FirewallPolicyAssociation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.FirewallPolicyAssociation|FirewallPolicyAssociation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_firewall_policies.get_association.js * region_tag:compute_v1_generated_NetworkFirewallPolicies_GetAssociation_async @@ -1050,9 +1044,8 @@ export class NetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_firewall_policies.get_iam_policy.js * region_tag:compute_v1_generated_NetworkFirewallPolicies_GetIamPolicy_async @@ -1152,9 +1145,8 @@ export class NetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.FirewallPolicyRule | FirewallPolicyRule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.FirewallPolicyRule|FirewallPolicyRule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_firewall_policies.get_rule.js * region_tag:compute_v1_generated_NetworkFirewallPolicies_GetRule_async @@ -1256,8 +1248,7 @@ export class NetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1378,8 +1369,7 @@ export class NetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1503,8 +1493,7 @@ export class NetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1626,8 +1615,7 @@ export class NetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1749,8 +1737,7 @@ export class NetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1868,9 +1855,8 @@ export class NetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_firewall_policies.set_iam_policy.js * region_tag:compute_v1_generated_NetworkFirewallPolicies_SetIamPolicy_async @@ -1970,9 +1956,8 @@ export class NetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/network_firewall_policies.test_iam_permissions.js * region_tag:compute_v1_generated_NetworkFirewallPolicies_TestIamPermissions_async @@ -2079,14 +2064,13 @@ export class NetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -2175,13 +2159,12 @@ export class NetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -2227,12 +2210,11 @@ export class NetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/network_firewall_policies.list.js * region_tag:compute_v1_generated_NetworkFirewallPolicies_List_async diff --git a/packages/google-cloud-compute/src/v1/networks_client.ts b/packages/google-cloud-compute/src/v1/networks_client.ts index 431bc897fe1a..9defee85b5d5 100644 --- a/packages/google-cloud-compute/src/v1/networks_client.ts +++ b/packages/google-cloud-compute/src/v1/networks_client.ts @@ -355,8 +355,7 @@ export class NetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -476,8 +475,7 @@ export class NetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -587,9 +585,8 @@ export class NetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Network | Network}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Network|Network}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/networks.get.js * region_tag:compute_v1_generated_Networks_Get_async @@ -673,9 +670,8 @@ export class NetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.NetworksGetEffectiveFirewallsResponse | NetworksGetEffectiveFirewallsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.NetworksGetEffectiveFirewallsResponse|NetworksGetEffectiveFirewallsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/networks.get_effective_firewalls.js * region_tag:compute_v1_generated_Networks_GetEffectiveFirewalls_async @@ -777,8 +773,7 @@ export class NetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -893,8 +888,7 @@ export class NetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1010,8 +1004,7 @@ export class NetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1131,8 +1124,7 @@ export class NetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1254,8 +1246,7 @@ export class NetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1380,14 +1371,13 @@ export class NetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Network | Network}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Network|Network}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1476,13 +1466,12 @@ export class NetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Network | Network} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Network|Network} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1528,12 +1517,11 @@ export class NetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Network | Network}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Network|Network}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/networks.list.js * region_tag:compute_v1_generated_Networks_List_async @@ -1588,14 +1576,13 @@ export class NetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.ExchangedPeeringRoute | ExchangedPeeringRoute}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.ExchangedPeeringRoute|ExchangedPeeringRoute}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listPeeringRoutesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPeeringRoutes( @@ -1702,13 +1689,12 @@ export class NetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.ExchangedPeeringRoute | ExchangedPeeringRoute} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.ExchangedPeeringRoute|ExchangedPeeringRoute} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listPeeringRoutesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPeeringRoutesStream( @@ -1764,12 +1750,11 @@ export class NetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.ExchangedPeeringRoute | ExchangedPeeringRoute}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.ExchangedPeeringRoute|ExchangedPeeringRoute}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/networks.list_peering_routes.js * region_tag:compute_v1_generated_Networks_ListPeeringRoutes_async diff --git a/packages/google-cloud-compute/src/v1/node_groups_client.ts b/packages/google-cloud-compute/src/v1/node_groups_client.ts index 6fd3eaa06ea3..c2ea7637c6cd 100644 --- a/packages/google-cloud-compute/src/v1/node_groups_client.ts +++ b/packages/google-cloud-compute/src/v1/node_groups_client.ts @@ -365,8 +365,7 @@ export class NodeGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -489,8 +488,7 @@ export class NodeGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -609,8 +607,7 @@ export class NodeGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -729,9 +726,8 @@ export class NodeGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.NodeGroup | NodeGroup}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.NodeGroup|NodeGroup}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/node_groups.get.js * region_tag:compute_v1_generated_NodeGroups_Get_async @@ -822,9 +818,8 @@ export class NodeGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/node_groups.get_iam_policy.js * region_tag:compute_v1_generated_NodeGroups_GetIamPolicy_async @@ -925,8 +920,7 @@ export class NodeGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1044,8 +1038,7 @@ export class NodeGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1160,9 +1153,8 @@ export class NodeGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/node_groups.set_iam_policy.js * region_tag:compute_v1_generated_NodeGroups_SetIamPolicy_async @@ -1263,8 +1255,7 @@ export class NodeGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1389,8 +1380,7 @@ export class NodeGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1511,9 +1501,8 @@ export class NodeGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/node_groups.test_iam_permissions.js * region_tag:compute_v1_generated_NodeGroups_TestIamPermissions_async @@ -1624,12 +1613,11 @@ export class NodeGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.NodeGroupsScopedList | NodeGroupsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.NodeGroupsScopedList|NodeGroupsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/node_groups.aggregated_list.js * region_tag:compute_v1_generated_NodeGroups_AggregatedList_async @@ -1681,14 +1669,13 @@ export class NodeGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.NodeGroup | NodeGroup}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.NodeGroup|NodeGroup}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1780,13 +1767,12 @@ export class NodeGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.NodeGroup | NodeGroup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.NodeGroup|NodeGroup} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1835,12 +1821,11 @@ export class NodeGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.NodeGroup | NodeGroup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.NodeGroup|NodeGroup}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/node_groups.list.js * region_tag:compute_v1_generated_NodeGroups_List_async @@ -1891,14 +1876,13 @@ export class NodeGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.NodeGroupNode | NodeGroupNode}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.NodeGroupNode|NodeGroupNode}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listNodesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNodes( @@ -1995,13 +1979,12 @@ export class NodeGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.NodeGroupNode | NodeGroupNode} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.NodeGroupNode|NodeGroupNode} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listNodesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNodesStream( @@ -2053,12 +2036,11 @@ export class NodeGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.NodeGroupNode | NodeGroupNode}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.NodeGroupNode|NodeGroupNode}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/node_groups.list_nodes.js * region_tag:compute_v1_generated_NodeGroups_ListNodes_async diff --git a/packages/google-cloud-compute/src/v1/node_templates_client.ts b/packages/google-cloud-compute/src/v1/node_templates_client.ts index 9eedbeea46c1..0134eb64cb38 100644 --- a/packages/google-cloud-compute/src/v1/node_templates_client.ts +++ b/packages/google-cloud-compute/src/v1/node_templates_client.ts @@ -352,8 +352,7 @@ export class NodeTemplatesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -472,9 +471,8 @@ export class NodeTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.NodeTemplate | NodeTemplate}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.NodeTemplate|NodeTemplate}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/node_templates.get.js * region_tag:compute_v1_generated_NodeTemplates_Get_async @@ -565,9 +563,8 @@ export class NodeTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/node_templates.get_iam_policy.js * region_tag:compute_v1_generated_NodeTemplates_GetIamPolicy_async @@ -672,8 +669,7 @@ export class NodeTemplatesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -793,9 +789,8 @@ export class NodeTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/node_templates.set_iam_policy.js * region_tag:compute_v1_generated_NodeTemplates_SetIamPolicy_async @@ -898,9 +893,8 @@ export class NodeTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/node_templates.test_iam_permissions.js * region_tag:compute_v1_generated_NodeTemplates_TestIamPermissions_async @@ -1011,12 +1005,11 @@ export class NodeTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.NodeTemplatesScopedList | NodeTemplatesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.NodeTemplatesScopedList|NodeTemplatesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/node_templates.aggregated_list.js * region_tag:compute_v1_generated_NodeTemplates_AggregatedList_async @@ -1068,14 +1061,13 @@ export class NodeTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.NodeTemplate | NodeTemplate}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.NodeTemplate|NodeTemplate}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1167,13 +1159,12 @@ export class NodeTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.NodeTemplate | NodeTemplate} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.NodeTemplate|NodeTemplate} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1222,12 +1213,11 @@ export class NodeTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.NodeTemplate | NodeTemplate}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.NodeTemplate|NodeTemplate}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/node_templates.list.js * region_tag:compute_v1_generated_NodeTemplates_List_async diff --git a/packages/google-cloud-compute/src/v1/node_types_client.ts b/packages/google-cloud-compute/src/v1/node_types_client.ts index fa44fbed2b03..29e88c784bbf 100644 --- a/packages/google-cloud-compute/src/v1/node_types_client.ts +++ b/packages/google-cloud-compute/src/v1/node_types_client.ts @@ -339,9 +339,8 @@ export class NodeTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.NodeType | NodeType}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.NodeType|NodeType}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/node_types.get.js * region_tag:compute_v1_generated_NodeTypes_Get_async @@ -438,12 +437,11 @@ export class NodeTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.NodeTypesScopedList | NodeTypesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.NodeTypesScopedList|NodeTypesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/node_types.aggregated_list.js * region_tag:compute_v1_generated_NodeTypes_AggregatedList_async @@ -495,14 +493,13 @@ export class NodeTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.NodeType | NodeType}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.NodeType|NodeType}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -594,13 +591,12 @@ export class NodeTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.NodeType | NodeType} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.NodeType|NodeType} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -649,12 +645,11 @@ export class NodeTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.NodeType | NodeType}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.NodeType|NodeType}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/node_types.list.js * region_tag:compute_v1_generated_NodeTypes_List_async diff --git a/packages/google-cloud-compute/src/v1/packet_mirrorings_client.ts b/packages/google-cloud-compute/src/v1/packet_mirrorings_client.ts index 8db14795298d..38a58f01d998 100644 --- a/packages/google-cloud-compute/src/v1/packet_mirrorings_client.ts +++ b/packages/google-cloud-compute/src/v1/packet_mirrorings_client.ts @@ -351,8 +351,7 @@ export class PacketMirroringsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -471,9 +470,8 @@ export class PacketMirroringsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.PacketMirroring | PacketMirroring}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.PacketMirroring|PacketMirroring}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/packet_mirrorings.get.js * region_tag:compute_v1_generated_PacketMirrorings_Get_async @@ -572,8 +570,7 @@ export class PacketMirroringsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -697,8 +694,7 @@ export class PacketMirroringsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -819,9 +815,8 @@ export class PacketMirroringsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/packet_mirrorings.test_iam_permissions.js * region_tag:compute_v1_generated_PacketMirrorings_TestIamPermissions_async @@ -932,12 +927,11 @@ export class PacketMirroringsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.PacketMirroringsScopedList | PacketMirroringsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.PacketMirroringsScopedList|PacketMirroringsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/packet_mirrorings.aggregated_list.js * region_tag:compute_v1_generated_PacketMirrorings_AggregatedList_async @@ -989,14 +983,13 @@ export class PacketMirroringsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.PacketMirroring | PacketMirroring}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.PacketMirroring|PacketMirroring}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1090,13 +1083,12 @@ export class PacketMirroringsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.PacketMirroring | PacketMirroring} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.PacketMirroring|PacketMirroring} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1145,12 +1137,11 @@ export class PacketMirroringsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.PacketMirroring | PacketMirroring}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.PacketMirroring|PacketMirroring}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/packet_mirrorings.list.js * region_tag:compute_v1_generated_PacketMirrorings_List_async diff --git a/packages/google-cloud-compute/src/v1/projects_client.ts b/packages/google-cloud-compute/src/v1/projects_client.ts index c071d3484477..41a0d7d54fa5 100644 --- a/packages/google-cloud-compute/src/v1/projects_client.ts +++ b/packages/google-cloud-compute/src/v1/projects_client.ts @@ -353,8 +353,7 @@ export class ProjectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -473,8 +472,7 @@ export class ProjectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -591,8 +589,7 @@ export class ProjectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -711,8 +708,7 @@ export class ProjectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -825,9 +821,8 @@ export class ProjectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Project | Project}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Project|Project}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/projects.get.js * region_tag:compute_v1_generated_Projects_Get_async @@ -908,9 +903,8 @@ export class ProjectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Project | Project}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Project|Project}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/projects.get_xpn_host.js * region_tag:compute_v1_generated_Projects_GetXpnHost_async @@ -1005,8 +999,7 @@ export class ProjectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1119,8 +1112,7 @@ export class ProjectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1239,8 +1231,7 @@ export class ProjectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1359,8 +1350,7 @@ export class ProjectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1479,8 +1469,7 @@ export class ProjectsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1604,14 +1593,13 @@ export class ProjectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.XpnResourceId | XpnResourceId}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.XpnResourceId|XpnResourceId}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `getXpnResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ getXpnResources( @@ -1708,13 +1696,12 @@ export class ProjectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.XpnResourceId | XpnResourceId} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.XpnResourceId|XpnResourceId} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `getXpnResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ getXpnResourcesStream( @@ -1760,12 +1747,11 @@ export class ProjectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.XpnResourceId | XpnResourceId}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.XpnResourceId|XpnResourceId}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/projects.get_xpn_resources.js * region_tag:compute_v1_generated_Projects_GetXpnResources_async @@ -1813,14 +1799,13 @@ export class ProjectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Project | Project}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Project|Project}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listXpnHostsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listXpnHosts( @@ -1911,13 +1896,12 @@ export class ProjectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Project | Project} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Project|Project} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listXpnHostsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listXpnHostsStream( @@ -1965,12 +1949,11 @@ export class ProjectsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Project | Project}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Project|Project}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/projects.list_xpn_hosts.js * region_tag:compute_v1_generated_Projects_ListXpnHosts_async diff --git a/packages/google-cloud-compute/src/v1/public_advertised_prefixes_client.ts b/packages/google-cloud-compute/src/v1/public_advertised_prefixes_client.ts index d7425786feb0..684af0fb09d0 100644 --- a/packages/google-cloud-compute/src/v1/public_advertised_prefixes_client.ts +++ b/packages/google-cloud-compute/src/v1/public_advertised_prefixes_client.ts @@ -344,8 +344,7 @@ export class PublicAdvertisedPrefixesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -461,9 +460,8 @@ export class PublicAdvertisedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.PublicAdvertisedPrefix | PublicAdvertisedPrefix}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.PublicAdvertisedPrefix|PublicAdvertisedPrefix}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/public_advertised_prefixes.get.js * region_tag:compute_v1_generated_PublicAdvertisedPrefixes_Get_async @@ -565,8 +563,7 @@ export class PublicAdvertisedPrefixesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -687,8 +684,7 @@ export class PublicAdvertisedPrefixesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -813,14 +809,13 @@ export class PublicAdvertisedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.PublicAdvertisedPrefix | PublicAdvertisedPrefix}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.PublicAdvertisedPrefix|PublicAdvertisedPrefix}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -917,13 +912,12 @@ export class PublicAdvertisedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.PublicAdvertisedPrefix | PublicAdvertisedPrefix} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.PublicAdvertisedPrefix|PublicAdvertisedPrefix} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -969,12 +963,11 @@ export class PublicAdvertisedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.PublicAdvertisedPrefix | PublicAdvertisedPrefix}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.PublicAdvertisedPrefix|PublicAdvertisedPrefix}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/public_advertised_prefixes.list.js * region_tag:compute_v1_generated_PublicAdvertisedPrefixes_List_async diff --git a/packages/google-cloud-compute/src/v1/public_delegated_prefixes_client.ts b/packages/google-cloud-compute/src/v1/public_delegated_prefixes_client.ts index 257dd392911c..c6508e8e8959 100644 --- a/packages/google-cloud-compute/src/v1/public_delegated_prefixes_client.ts +++ b/packages/google-cloud-compute/src/v1/public_delegated_prefixes_client.ts @@ -351,8 +351,7 @@ export class PublicDelegatedPrefixesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -471,9 +470,8 @@ export class PublicDelegatedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.PublicDelegatedPrefix | PublicDelegatedPrefix}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.PublicDelegatedPrefix|PublicDelegatedPrefix}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/public_delegated_prefixes.get.js * region_tag:compute_v1_generated_PublicDelegatedPrefixes_Get_async @@ -578,8 +576,7 @@ export class PublicDelegatedPrefixesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -703,8 +700,7 @@ export class PublicDelegatedPrefixesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -833,12 +829,11 @@ export class PublicDelegatedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.PublicDelegatedPrefixesScopedList | PublicDelegatedPrefixesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.PublicDelegatedPrefixesScopedList|PublicDelegatedPrefixesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/public_delegated_prefixes.aggregated_list.js * region_tag:compute_v1_generated_PublicDelegatedPrefixes_AggregatedList_async @@ -893,14 +888,13 @@ export class PublicDelegatedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.PublicDelegatedPrefix | PublicDelegatedPrefix}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.PublicDelegatedPrefix|PublicDelegatedPrefix}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1000,13 +994,12 @@ export class PublicDelegatedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.PublicDelegatedPrefix | PublicDelegatedPrefix} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.PublicDelegatedPrefix|PublicDelegatedPrefix} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1055,12 +1048,11 @@ export class PublicDelegatedPrefixesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.PublicDelegatedPrefix | PublicDelegatedPrefix}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.PublicDelegatedPrefix|PublicDelegatedPrefix}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/public_delegated_prefixes.list.js * region_tag:compute_v1_generated_PublicDelegatedPrefixes_List_async diff --git a/packages/google-cloud-compute/src/v1/region_autoscalers_client.ts b/packages/google-cloud-compute/src/v1/region_autoscalers_client.ts index 074ad53175cd..733fecf90f9d 100644 --- a/packages/google-cloud-compute/src/v1/region_autoscalers_client.ts +++ b/packages/google-cloud-compute/src/v1/region_autoscalers_client.ts @@ -345,8 +345,7 @@ export class RegionAutoscalersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -465,9 +464,8 @@ export class RegionAutoscalersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Autoscaler | Autoscaler}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Autoscaler|Autoscaler}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_autoscalers.get.js * region_tag:compute_v1_generated_RegionAutoscalers_Get_async @@ -566,8 +564,7 @@ export class RegionAutoscalersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -691,8 +688,7 @@ export class RegionAutoscalersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -816,8 +812,7 @@ export class RegionAutoscalersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -944,14 +939,13 @@ export class RegionAutoscalersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Autoscaler | Autoscaler}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Autoscaler|Autoscaler}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1045,13 +1039,12 @@ export class RegionAutoscalersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Autoscaler | Autoscaler} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Autoscaler|Autoscaler} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1100,12 +1093,11 @@ export class RegionAutoscalersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Autoscaler | Autoscaler}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Autoscaler|Autoscaler}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_autoscalers.list.js * region_tag:compute_v1_generated_RegionAutoscalers_List_async diff --git a/packages/google-cloud-compute/src/v1/region_backend_services_client.ts b/packages/google-cloud-compute/src/v1/region_backend_services_client.ts index 37173894c848..a1fe79e64b5b 100644 --- a/packages/google-cloud-compute/src/v1/region_backend_services_client.ts +++ b/packages/google-cloud-compute/src/v1/region_backend_services_client.ts @@ -349,8 +349,7 @@ export class RegionBackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -469,9 +468,8 @@ export class RegionBackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.BackendService | BackendService}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.BackendService|BackendService}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_backend_services.get.js * region_tag:compute_v1_generated_RegionBackendServices_Get_async @@ -573,9 +571,8 @@ export class RegionBackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.BackendServiceGroupHealth | BackendServiceGroupHealth}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.BackendServiceGroupHealth|BackendServiceGroupHealth}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_backend_services.get_health.js * region_tag:compute_v1_generated_RegionBackendServices_GetHealth_async @@ -678,9 +675,8 @@ export class RegionBackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_backend_services.get_iam_policy.js * region_tag:compute_v1_generated_RegionBackendServices_GetIamPolicy_async @@ -785,8 +781,7 @@ export class RegionBackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -910,8 +905,7 @@ export class RegionBackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1032,9 +1026,8 @@ export class RegionBackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_backend_services.set_iam_policy.js * region_tag:compute_v1_generated_RegionBackendServices_SetIamPolicy_async @@ -1141,8 +1134,7 @@ export class RegionBackendServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1270,14 +1262,13 @@ export class RegionBackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.BackendService | BackendService}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.BackendService|BackendService}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1369,13 +1360,12 @@ export class RegionBackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.BackendService | BackendService} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.BackendService|BackendService} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1424,12 +1414,11 @@ export class RegionBackendServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.BackendService | BackendService}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.BackendService|BackendService}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_backend_services.list.js * region_tag:compute_v1_generated_RegionBackendServices_List_async diff --git a/packages/google-cloud-compute/src/v1/region_commitments_client.ts b/packages/google-cloud-compute/src/v1/region_commitments_client.ts index f03e9574c6d3..572e00e5b02d 100644 --- a/packages/google-cloud-compute/src/v1/region_commitments_client.ts +++ b/packages/google-cloud-compute/src/v1/region_commitments_client.ts @@ -345,9 +345,8 @@ export class RegionCommitmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Commitment | Commitment}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Commitment|Commitment}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_commitments.get.js * region_tag:compute_v1_generated_RegionCommitments_Get_async @@ -446,8 +445,7 @@ export class RegionCommitmentsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -574,8 +572,7 @@ export class RegionCommitmentsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -704,12 +701,11 @@ export class RegionCommitmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.CommitmentsScopedList | CommitmentsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.CommitmentsScopedList|CommitmentsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_commitments.aggregated_list.js * region_tag:compute_v1_generated_RegionCommitments_AggregatedList_async @@ -761,14 +757,13 @@ export class RegionCommitmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Commitment | Commitment}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Commitment|Commitment}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -860,13 +855,12 @@ export class RegionCommitmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Commitment | Commitment} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Commitment|Commitment} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -915,12 +909,11 @@ export class RegionCommitmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Commitment | Commitment}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Commitment|Commitment}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_commitments.list.js * region_tag:compute_v1_generated_RegionCommitments_List_async diff --git a/packages/google-cloud-compute/src/v1/region_disk_types_client.ts b/packages/google-cloud-compute/src/v1/region_disk_types_client.ts index 83193ad7cf58..249d59704d97 100644 --- a/packages/google-cloud-compute/src/v1/region_disk_types_client.ts +++ b/packages/google-cloud-compute/src/v1/region_disk_types_client.ts @@ -334,9 +334,8 @@ export class RegionDiskTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.DiskType | DiskType}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.DiskType|DiskType}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_disk_types.get.js * region_tag:compute_v1_generated_RegionDiskTypes_Get_async @@ -440,14 +439,13 @@ export class RegionDiskTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.DiskType | DiskType}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.DiskType|DiskType}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -539,13 +537,12 @@ export class RegionDiskTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.DiskType | DiskType} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.DiskType|DiskType} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -594,12 +591,11 @@ export class RegionDiskTypesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.DiskType | DiskType}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.DiskType|DiskType}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_disk_types.list.js * region_tag:compute_v1_generated_RegionDiskTypes_List_async diff --git a/packages/google-cloud-compute/src/v1/region_disks_client.ts b/packages/google-cloud-compute/src/v1/region_disks_client.ts index 7d1d72c15122..f49cc5b30767 100644 --- a/packages/google-cloud-compute/src/v1/region_disks_client.ts +++ b/packages/google-cloud-compute/src/v1/region_disks_client.ts @@ -358,8 +358,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -482,8 +481,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -607,8 +605,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -731,8 +728,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -851,9 +847,8 @@ export class RegionDisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Disk | Disk}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Disk|Disk}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_disks.get.js * region_tag:compute_v1_generated_RegionDisks_Get_async @@ -944,9 +939,8 @@ export class RegionDisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_disks.get_iam_policy.js * region_tag:compute_v1_generated_RegionDisks_GetIamPolicy_async @@ -1047,8 +1041,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1172,8 +1165,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1298,8 +1290,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1420,9 +1411,8 @@ export class RegionDisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_disks.set_iam_policy.js * region_tag:compute_v1_generated_RegionDisks_SetIamPolicy_async @@ -1523,8 +1513,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1649,8 +1638,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1773,8 +1761,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1897,8 +1884,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2018,9 +2004,8 @@ export class RegionDisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_disks.test_iam_permissions.js * region_tag:compute_v1_generated_RegionDisks_TestIamPermissions_async @@ -2130,8 +2115,7 @@ export class RegionDisksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2259,14 +2243,13 @@ export class RegionDisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Disk | Disk}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Disk|Disk}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -2358,13 +2341,12 @@ export class RegionDisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Disk | Disk} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Disk|Disk} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -2413,12 +2395,11 @@ export class RegionDisksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Disk | Disk}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Disk|Disk}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_disks.list.js * region_tag:compute_v1_generated_RegionDisks_List_async diff --git a/packages/google-cloud-compute/src/v1/region_health_check_services_client.ts b/packages/google-cloud-compute/src/v1/region_health_check_services_client.ts index d3f0fad3a225..6dcbe96edafd 100644 --- a/packages/google-cloud-compute/src/v1/region_health_check_services_client.ts +++ b/packages/google-cloud-compute/src/v1/region_health_check_services_client.ts @@ -346,8 +346,7 @@ export class RegionHealthCheckServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -466,9 +465,8 @@ export class RegionHealthCheckServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.HealthCheckService | HealthCheckService}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.HealthCheckService|HealthCheckService}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_health_check_services.get.js * region_tag:compute_v1_generated_RegionHealthCheckServices_Get_async @@ -573,8 +571,7 @@ export class RegionHealthCheckServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -698,8 +695,7 @@ export class RegionHealthCheckServicesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -827,14 +823,13 @@ export class RegionHealthCheckServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.HealthCheckService | HealthCheckService}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.HealthCheckService|HealthCheckService}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -934,13 +929,12 @@ export class RegionHealthCheckServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.HealthCheckService | HealthCheckService} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.HealthCheckService|HealthCheckService} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -989,12 +983,11 @@ export class RegionHealthCheckServicesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.HealthCheckService | HealthCheckService}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.HealthCheckService|HealthCheckService}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_health_check_services.list.js * region_tag:compute_v1_generated_RegionHealthCheckServices_List_async diff --git a/packages/google-cloud-compute/src/v1/region_health_checks_client.ts b/packages/google-cloud-compute/src/v1/region_health_checks_client.ts index 816b7be10d2c..1c290c724506 100644 --- a/packages/google-cloud-compute/src/v1/region_health_checks_client.ts +++ b/packages/google-cloud-compute/src/v1/region_health_checks_client.ts @@ -345,8 +345,7 @@ export class RegionHealthChecksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -465,9 +464,8 @@ export class RegionHealthChecksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.HealthCheck | HealthCheck}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.HealthCheck|HealthCheck}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_health_checks.get.js * region_tag:compute_v1_generated_RegionHealthChecks_Get_async @@ -566,8 +564,7 @@ export class RegionHealthChecksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -691,8 +688,7 @@ export class RegionHealthChecksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -817,8 +813,7 @@ export class RegionHealthChecksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -946,14 +941,13 @@ export class RegionHealthChecksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.HealthCheck | HealthCheck}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.HealthCheck|HealthCheck}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1045,13 +1039,12 @@ export class RegionHealthChecksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.HealthCheck | HealthCheck} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.HealthCheck|HealthCheck} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1100,12 +1093,11 @@ export class RegionHealthChecksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.HealthCheck | HealthCheck}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.HealthCheck|HealthCheck}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_health_checks.list.js * region_tag:compute_v1_generated_RegionHealthChecks_List_async diff --git a/packages/google-cloud-compute/src/v1/region_instance_group_managers_client.ts b/packages/google-cloud-compute/src/v1/region_instance_group_managers_client.ts index 63ccf7be4ef0..95a822469785 100644 --- a/packages/google-cloud-compute/src/v1/region_instance_group_managers_client.ts +++ b/packages/google-cloud-compute/src/v1/region_instance_group_managers_client.ts @@ -377,8 +377,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -501,8 +500,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -627,8 +625,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -751,8 +748,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -877,8 +873,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1001,8 +996,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1121,9 +1115,8 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.InstanceGroupManager | InstanceGroupManager}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.InstanceGroupManager|InstanceGroupManager}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_group_managers.get.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_Get_async @@ -1228,8 +1221,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1353,8 +1345,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1479,8 +1470,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1605,8 +1595,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1731,8 +1720,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1857,8 +1845,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1983,8 +1970,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2109,8 +2095,7 @@ export class RegionInstanceGroupManagersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2238,14 +2223,13 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InstanceGroupManager | InstanceGroupManager}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InstanceGroupManager|InstanceGroupManager}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -2345,13 +2329,12 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InstanceGroupManager | InstanceGroupManager} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceGroupManager|InstanceGroupManager} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -2400,12 +2383,11 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InstanceGroupManager | InstanceGroupManager}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InstanceGroupManager|InstanceGroupManager}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_group_managers.list.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_List_async @@ -2456,14 +2438,13 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InstanceManagedByIgmError | InstanceManagedByIgmError}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InstanceManagedByIgmError|InstanceManagedByIgmError}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listErrorsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listErrors( @@ -2566,13 +2547,12 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InstanceManagedByIgmError | InstanceManagedByIgmError} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceManagedByIgmError|InstanceManagedByIgmError} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listErrorsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listErrorsStream( @@ -2624,12 +2604,11 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InstanceManagedByIgmError | InstanceManagedByIgmError}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InstanceManagedByIgmError|InstanceManagedByIgmError}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_group_managers.list_errors.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_ListErrors_async @@ -2681,14 +2660,13 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.ManagedInstance | ManagedInstance}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.ManagedInstance|ManagedInstance}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listManagedInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listManagedInstances( @@ -2791,13 +2769,12 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.ManagedInstance | ManagedInstance} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.ManagedInstance|ManagedInstance} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listManagedInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listManagedInstancesStream( @@ -2849,12 +2826,11 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.ManagedInstance | ManagedInstance}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.ManagedInstance|ManagedInstance}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_group_managers.list_managed_instances.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_ListManagedInstances_async @@ -2906,14 +2882,13 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.PerInstanceConfig | PerInstanceConfig}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.PerInstanceConfig|PerInstanceConfig}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listPerInstanceConfigsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPerInstanceConfigs( @@ -3020,13 +2995,12 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.PerInstanceConfig | PerInstanceConfig} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.PerInstanceConfig|PerInstanceConfig} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listPerInstanceConfigsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPerInstanceConfigsStream( @@ -3078,12 +3052,11 @@ export class RegionInstanceGroupManagersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.PerInstanceConfig | PerInstanceConfig}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.PerInstanceConfig|PerInstanceConfig}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_group_managers.list_per_instance_configs.js * region_tag:compute_v1_generated_RegionInstanceGroupManagers_ListPerInstanceConfigs_async diff --git a/packages/google-cloud-compute/src/v1/region_instance_groups_client.ts b/packages/google-cloud-compute/src/v1/region_instance_groups_client.ts index 20119ddbcb52..7a48c8884cfc 100644 --- a/packages/google-cloud-compute/src/v1/region_instance_groups_client.ts +++ b/packages/google-cloud-compute/src/v1/region_instance_groups_client.ts @@ -344,9 +344,8 @@ export class RegionInstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.InstanceGroup | InstanceGroup}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.InstanceGroup|InstanceGroup}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_groups.get.js * region_tag:compute_v1_generated_RegionInstanceGroups_Get_async @@ -447,8 +446,7 @@ export class RegionInstanceGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -576,14 +574,13 @@ export class RegionInstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InstanceGroup | InstanceGroup}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InstanceGroup|InstanceGroup}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -683,13 +680,12 @@ export class RegionInstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InstanceGroup | InstanceGroup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceGroup|InstanceGroup} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -738,12 +734,11 @@ export class RegionInstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InstanceGroup | InstanceGroup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InstanceGroup|InstanceGroup}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_groups.list.js * region_tag:compute_v1_generated_RegionInstanceGroups_List_async @@ -796,14 +791,13 @@ export class RegionInstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InstanceWithNamedPorts | InstanceWithNamedPorts}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InstanceWithNamedPorts|InstanceWithNamedPorts}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstances( @@ -908,13 +902,12 @@ export class RegionInstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InstanceWithNamedPorts | InstanceWithNamedPorts} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceWithNamedPorts|InstanceWithNamedPorts} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listInstancesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listInstancesStream( @@ -968,12 +961,11 @@ export class RegionInstanceGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InstanceWithNamedPorts | InstanceWithNamedPorts}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InstanceWithNamedPorts|InstanceWithNamedPorts}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_groups.list_instances.js * region_tag:compute_v1_generated_RegionInstanceGroups_ListInstances_async diff --git a/packages/google-cloud-compute/src/v1/region_instance_templates_client.ts b/packages/google-cloud-compute/src/v1/region_instance_templates_client.ts index 4bafa6e56c69..d86b1465438e 100644 --- a/packages/google-cloud-compute/src/v1/region_instance_templates_client.ts +++ b/packages/google-cloud-compute/src/v1/region_instance_templates_client.ts @@ -344,8 +344,7 @@ export class RegionInstanceTemplatesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -464,9 +463,8 @@ export class RegionInstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.InstanceTemplate | InstanceTemplate}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.InstanceTemplate|InstanceTemplate}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_templates.get.js * region_tag:compute_v1_generated_RegionInstanceTemplates_Get_async @@ -571,8 +569,7 @@ export class RegionInstanceTemplatesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -699,14 +696,13 @@ export class RegionInstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.InstanceTemplate | InstanceTemplate}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.InstanceTemplate|InstanceTemplate}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -800,13 +796,12 @@ export class RegionInstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.InstanceTemplate | InstanceTemplate} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.InstanceTemplate|InstanceTemplate} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -855,12 +850,11 @@ export class RegionInstanceTemplatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.InstanceTemplate | InstanceTemplate}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.InstanceTemplate|InstanceTemplate}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_instance_templates.list.js * region_tag:compute_v1_generated_RegionInstanceTemplates_List_async diff --git a/packages/google-cloud-compute/src/v1/region_instances_client.ts b/packages/google-cloud-compute/src/v1/region_instances_client.ts index 4fcaea23c35b..fbb753805f47 100644 --- a/packages/google-cloud-compute/src/v1/region_instances_client.ts +++ b/packages/google-cloud-compute/src/v1/region_instances_client.ts @@ -325,8 +325,7 @@ export class RegionInstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, diff --git a/packages/google-cloud-compute/src/v1/region_network_endpoint_groups_client.ts b/packages/google-cloud-compute/src/v1/region_network_endpoint_groups_client.ts index 882143dbaf23..33e3201b1404 100644 --- a/packages/google-cloud-compute/src/v1/region_network_endpoint_groups_client.ts +++ b/packages/google-cloud-compute/src/v1/region_network_endpoint_groups_client.ts @@ -345,8 +345,7 @@ export class RegionNetworkEndpointGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -465,9 +464,8 @@ export class RegionNetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_network_endpoint_groups.get.js * region_tag:compute_v1_generated_RegionNetworkEndpointGroups_Get_async @@ -572,8 +570,7 @@ export class RegionNetworkEndpointGroupsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -700,14 +697,13 @@ export class RegionNetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -807,13 +803,12 @@ export class RegionNetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -862,12 +857,11 @@ export class RegionNetworkEndpointGroupsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.NetworkEndpointGroup | NetworkEndpointGroup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.NetworkEndpointGroup|NetworkEndpointGroup}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_network_endpoint_groups.list.js * region_tag:compute_v1_generated_RegionNetworkEndpointGroups_List_async diff --git a/packages/google-cloud-compute/src/v1/region_network_firewall_policies_client.ts b/packages/google-cloud-compute/src/v1/region_network_firewall_policies_client.ts index b74aae424510..8c778eec4d18 100644 --- a/packages/google-cloud-compute/src/v1/region_network_firewall_policies_client.ts +++ b/packages/google-cloud-compute/src/v1/region_network_firewall_policies_client.ts @@ -362,8 +362,7 @@ export class RegionNetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -492,8 +491,7 @@ export class RegionNetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -618,8 +616,7 @@ export class RegionNetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -742,8 +739,7 @@ export class RegionNetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -862,9 +858,8 @@ export class RegionNetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_network_firewall_policies.get.js * region_tag:compute_v1_generated_RegionNetworkFirewallPolicies_Get_async @@ -967,9 +962,8 @@ export class RegionNetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.FirewallPolicyAssociation | FirewallPolicyAssociation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.FirewallPolicyAssociation|FirewallPolicyAssociation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_network_firewall_policies.get_association.js * region_tag:compute_v1_generated_RegionNetworkFirewallPolicies_GetAssociation_async @@ -1070,9 +1064,8 @@ export class RegionNetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse | RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse|RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_network_firewall_policies.get_effective_firewalls.js * region_tag:compute_v1_generated_RegionNetworkFirewallPolicies_GetEffectiveFirewalls_async @@ -1174,9 +1167,8 @@ export class RegionNetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_network_firewall_policies.get_iam_policy.js * region_tag:compute_v1_generated_RegionNetworkFirewallPolicies_GetIamPolicy_async @@ -1279,9 +1271,8 @@ export class RegionNetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.FirewallPolicyRule | FirewallPolicyRule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.FirewallPolicyRule|FirewallPolicyRule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_network_firewall_policies.get_rule.js * region_tag:compute_v1_generated_RegionNetworkFirewallPolicies_GetRule_async @@ -1386,8 +1377,7 @@ export class RegionNetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1511,8 +1501,7 @@ export class RegionNetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1639,8 +1628,7 @@ export class RegionNetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1765,8 +1753,7 @@ export class RegionNetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1891,8 +1878,7 @@ export class RegionNetworkFirewallPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -2013,9 +1999,8 @@ export class RegionNetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_network_firewall_policies.set_iam_policy.js * region_tag:compute_v1_generated_RegionNetworkFirewallPolicies_SetIamPolicy_async @@ -2118,9 +2103,8 @@ export class RegionNetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_network_firewall_policies.test_iam_permissions.js * region_tag:compute_v1_generated_RegionNetworkFirewallPolicies_TestIamPermissions_async @@ -2230,14 +2214,13 @@ export class RegionNetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -2329,13 +2312,12 @@ export class RegionNetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -2384,12 +2366,11 @@ export class RegionNetworkFirewallPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.FirewallPolicy | FirewallPolicy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.FirewallPolicy|FirewallPolicy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_network_firewall_policies.list.js * region_tag:compute_v1_generated_RegionNetworkFirewallPolicies_List_async diff --git a/packages/google-cloud-compute/src/v1/region_notification_endpoints_client.ts b/packages/google-cloud-compute/src/v1/region_notification_endpoints_client.ts index d76f65928b95..7cbb3d8de8a4 100644 --- a/packages/google-cloud-compute/src/v1/region_notification_endpoints_client.ts +++ b/packages/google-cloud-compute/src/v1/region_notification_endpoints_client.ts @@ -345,8 +345,7 @@ export class RegionNotificationEndpointsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -465,9 +464,8 @@ export class RegionNotificationEndpointsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.NotificationEndpoint | NotificationEndpoint}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.NotificationEndpoint|NotificationEndpoint}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_notification_endpoints.get.js * region_tag:compute_v1_generated_RegionNotificationEndpoints_Get_async @@ -572,8 +570,7 @@ export class RegionNotificationEndpointsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -700,14 +697,13 @@ export class RegionNotificationEndpointsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.NotificationEndpoint | NotificationEndpoint}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.NotificationEndpoint|NotificationEndpoint}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -807,13 +803,12 @@ export class RegionNotificationEndpointsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.NotificationEndpoint | NotificationEndpoint} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.NotificationEndpoint|NotificationEndpoint} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -862,12 +857,11 @@ export class RegionNotificationEndpointsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.NotificationEndpoint | NotificationEndpoint}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.NotificationEndpoint|NotificationEndpoint}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_notification_endpoints.list.js * region_tag:compute_v1_generated_RegionNotificationEndpoints_List_async diff --git a/packages/google-cloud-compute/src/v1/region_operations_client.ts b/packages/google-cloud-compute/src/v1/region_operations_client.ts index 7e68d09cb4c8..605afe51b79e 100644 --- a/packages/google-cloud-compute/src/v1/region_operations_client.ts +++ b/packages/google-cloud-compute/src/v1/region_operations_client.ts @@ -333,9 +333,8 @@ export class RegionOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.DeleteRegionOperationResponse | DeleteRegionOperationResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.DeleteRegionOperationResponse|DeleteRegionOperationResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_operations.delete.js * region_tag:compute_v1_generated_RegionOperations_Delete_async @@ -430,9 +429,8 @@ export class RegionOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Operation | Operation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Operation|Operation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_operations.get.js * region_tag:compute_v1_generated_RegionOperations_Get_async @@ -527,9 +525,8 @@ export class RegionOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Operation | Operation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Operation|Operation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_operations.wait.js * region_tag:compute_v1_generated_RegionOperations_Wait_async @@ -633,14 +630,13 @@ export class RegionOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Operation | Operation}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Operation|Operation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -732,13 +728,12 @@ export class RegionOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Operation | Operation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Operation|Operation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -787,12 +782,11 @@ export class RegionOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Operation | Operation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Operation|Operation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_operations.list.js * region_tag:compute_v1_generated_RegionOperations_List_async diff --git a/packages/google-cloud-compute/src/v1/region_security_policies_client.ts b/packages/google-cloud-compute/src/v1/region_security_policies_client.ts index ff3bdde42ee2..294b63953480 100644 --- a/packages/google-cloud-compute/src/v1/region_security_policies_client.ts +++ b/packages/google-cloud-compute/src/v1/region_security_policies_client.ts @@ -345,8 +345,7 @@ export class RegionSecurityPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -465,9 +464,8 @@ export class RegionSecurityPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SecurityPolicy | SecurityPolicy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SecurityPolicy|SecurityPolicy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_security_policies.get.js * region_tag:compute_v1_generated_RegionSecurityPolicies_Get_async @@ -574,8 +572,7 @@ export class RegionSecurityPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -680,7 +677,7 @@ export class RegionSecurityPoliciesClient { ); } /** - * Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. + * Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. * * @param {Object} request * The request object that will be sent. @@ -699,8 +696,7 @@ export class RegionSecurityPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -828,14 +824,13 @@ export class RegionSecurityPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.SecurityPolicy | SecurityPolicy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.SecurityPolicy|SecurityPolicy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -927,13 +922,12 @@ export class RegionSecurityPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.SecurityPolicy | SecurityPolicy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.SecurityPolicy|SecurityPolicy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -982,12 +976,11 @@ export class RegionSecurityPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.SecurityPolicy | SecurityPolicy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.SecurityPolicy|SecurityPolicy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_security_policies.list.js * region_tag:compute_v1_generated_RegionSecurityPolicies_List_async diff --git a/packages/google-cloud-compute/src/v1/region_ssl_certificates_client.ts b/packages/google-cloud-compute/src/v1/region_ssl_certificates_client.ts index e295a4ba90e4..16ee8f44339a 100644 --- a/packages/google-cloud-compute/src/v1/region_ssl_certificates_client.ts +++ b/packages/google-cloud-compute/src/v1/region_ssl_certificates_client.ts @@ -344,8 +344,7 @@ export class RegionSslCertificatesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -464,9 +463,8 @@ export class RegionSslCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SslCertificate | SslCertificate}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SslCertificate|SslCertificate}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_ssl_certificates.get.js * region_tag:compute_v1_generated_RegionSslCertificates_Get_async @@ -571,8 +569,7 @@ export class RegionSslCertificatesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -699,14 +696,13 @@ export class RegionSslCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.SslCertificate | SslCertificate}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.SslCertificate|SslCertificate}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -798,13 +794,12 @@ export class RegionSslCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.SslCertificate | SslCertificate} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.SslCertificate|SslCertificate} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -853,12 +848,11 @@ export class RegionSslCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.SslCertificate | SslCertificate}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.SslCertificate|SslCertificate}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_ssl_certificates.list.js * region_tag:compute_v1_generated_RegionSslCertificates_List_async diff --git a/packages/google-cloud-compute/src/v1/region_ssl_policies_client.ts b/packages/google-cloud-compute/src/v1/region_ssl_policies_client.ts index 8fa642d1894d..5e4e35f84397 100644 --- a/packages/google-cloud-compute/src/v1/region_ssl_policies_client.ts +++ b/packages/google-cloud-compute/src/v1/region_ssl_policies_client.ts @@ -345,8 +345,7 @@ export class RegionSslPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -465,9 +464,8 @@ export class RegionSslPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SslPolicy | SslPolicy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SslPolicy|SslPolicy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_ssl_policies.get.js * region_tag:compute_v1_generated_RegionSslPolicies_Get_async @@ -566,8 +564,7 @@ export class RegionSslPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -693,9 +690,8 @@ export class RegionSslPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SslPoliciesListAvailableFeaturesResponse | SslPoliciesListAvailableFeaturesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SslPoliciesListAvailableFeaturesResponse|SslPoliciesListAvailableFeaturesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_ssl_policies.list_available_features.js * region_tag:compute_v1_generated_RegionSslPolicies_ListAvailableFeatures_async @@ -801,8 +797,7 @@ export class RegionSslPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -930,14 +925,13 @@ export class RegionSslPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.SslPolicy | SslPolicy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.SslPolicy|SslPolicy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1029,13 +1023,12 @@ export class RegionSslPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.SslPolicy | SslPolicy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.SslPolicy|SslPolicy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1084,12 +1077,11 @@ export class RegionSslPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.SslPolicy | SslPolicy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.SslPolicy|SslPolicy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_ssl_policies.list.js * region_tag:compute_v1_generated_RegionSslPolicies_List_async diff --git a/packages/google-cloud-compute/src/v1/region_target_http_proxies_client.ts b/packages/google-cloud-compute/src/v1/region_target_http_proxies_client.ts index 8640793b9e4a..d5db84c10747 100644 --- a/packages/google-cloud-compute/src/v1/region_target_http_proxies_client.ts +++ b/packages/google-cloud-compute/src/v1/region_target_http_proxies_client.ts @@ -345,8 +345,7 @@ export class RegionTargetHttpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -465,9 +464,8 @@ export class RegionTargetHttpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetHttpProxy | TargetHttpProxy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetHttpProxy|TargetHttpProxy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_target_http_proxies.get.js * region_tag:compute_v1_generated_RegionTargetHttpProxies_Get_async @@ -572,8 +570,7 @@ export class RegionTargetHttpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -697,8 +694,7 @@ export class RegionTargetHttpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -826,14 +822,13 @@ export class RegionTargetHttpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.TargetHttpProxy | TargetHttpProxy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.TargetHttpProxy|TargetHttpProxy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -927,13 +922,12 @@ export class RegionTargetHttpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.TargetHttpProxy | TargetHttpProxy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.TargetHttpProxy|TargetHttpProxy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -982,12 +976,11 @@ export class RegionTargetHttpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.TargetHttpProxy | TargetHttpProxy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.TargetHttpProxy|TargetHttpProxy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_target_http_proxies.list.js * region_tag:compute_v1_generated_RegionTargetHttpProxies_List_async diff --git a/packages/google-cloud-compute/src/v1/region_target_https_proxies_client.ts b/packages/google-cloud-compute/src/v1/region_target_https_proxies_client.ts index f2c8fbff3f7d..5353a7a22a53 100644 --- a/packages/google-cloud-compute/src/v1/region_target_https_proxies_client.ts +++ b/packages/google-cloud-compute/src/v1/region_target_https_proxies_client.ts @@ -348,8 +348,7 @@ export class RegionTargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -468,9 +467,8 @@ export class RegionTargetHttpsProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetHttpsProxy | TargetHttpsProxy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetHttpsProxy|TargetHttpsProxy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_target_https_proxies.get.js * region_tag:compute_v1_generated_RegionTargetHttpsProxies_Get_async @@ -575,8 +573,7 @@ export class RegionTargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -700,8 +697,7 @@ export class RegionTargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -826,8 +822,7 @@ export class RegionTargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -952,8 +947,7 @@ export class RegionTargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1081,14 +1075,13 @@ export class RegionTargetHttpsProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.TargetHttpsProxy | TargetHttpsProxy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.TargetHttpsProxy|TargetHttpsProxy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1182,13 +1175,12 @@ export class RegionTargetHttpsProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.TargetHttpsProxy | TargetHttpsProxy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.TargetHttpsProxy|TargetHttpsProxy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1237,12 +1229,11 @@ export class RegionTargetHttpsProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.TargetHttpsProxy | TargetHttpsProxy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.TargetHttpsProxy|TargetHttpsProxy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_target_https_proxies.list.js * region_tag:compute_v1_generated_RegionTargetHttpsProxies_List_async diff --git a/packages/google-cloud-compute/src/v1/region_target_tcp_proxies_client.ts b/packages/google-cloud-compute/src/v1/region_target_tcp_proxies_client.ts index 063d3505c3f0..46d53e6ca1c7 100644 --- a/packages/google-cloud-compute/src/v1/region_target_tcp_proxies_client.ts +++ b/packages/google-cloud-compute/src/v1/region_target_tcp_proxies_client.ts @@ -344,8 +344,7 @@ export class RegionTargetTcpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -464,9 +463,8 @@ export class RegionTargetTcpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetTcpProxy | TargetTcpProxy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetTcpProxy|TargetTcpProxy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_target_tcp_proxies.get.js * region_tag:compute_v1_generated_RegionTargetTcpProxies_Get_async @@ -571,8 +569,7 @@ export class RegionTargetTcpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -699,14 +696,13 @@ export class RegionTargetTcpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.TargetTcpProxy | TargetTcpProxy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.TargetTcpProxy|TargetTcpProxy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -798,13 +794,12 @@ export class RegionTargetTcpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.TargetTcpProxy | TargetTcpProxy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.TargetTcpProxy|TargetTcpProxy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -853,12 +848,11 @@ export class RegionTargetTcpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.TargetTcpProxy | TargetTcpProxy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.TargetTcpProxy|TargetTcpProxy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_target_tcp_proxies.list.js * region_tag:compute_v1_generated_RegionTargetTcpProxies_List_async diff --git a/packages/google-cloud-compute/src/v1/region_url_maps_client.ts b/packages/google-cloud-compute/src/v1/region_url_maps_client.ts index 5d599a671bc5..ad8a64b1cdcb 100644 --- a/packages/google-cloud-compute/src/v1/region_url_maps_client.ts +++ b/packages/google-cloud-compute/src/v1/region_url_maps_client.ts @@ -346,8 +346,7 @@ export class RegionUrlMapsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -466,9 +465,8 @@ export class RegionUrlMapsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.UrlMap | UrlMap}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.UrlMap|UrlMap}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_url_maps.get.js * region_tag:compute_v1_generated_RegionUrlMaps_Get_async @@ -561,8 +559,7 @@ export class RegionUrlMapsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -686,8 +683,7 @@ export class RegionUrlMapsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -812,8 +808,7 @@ export class RegionUrlMapsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -934,9 +929,8 @@ export class RegionUrlMapsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.UrlMapsValidateResponse | UrlMapsValidateResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.UrlMapsValidateResponse|UrlMapsValidateResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/region_url_maps.validate.js * region_tag:compute_v1_generated_RegionUrlMaps_Validate_async @@ -1040,14 +1034,13 @@ export class RegionUrlMapsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.UrlMap | UrlMap}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.UrlMap|UrlMap}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1139,13 +1132,12 @@ export class RegionUrlMapsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.UrlMap | UrlMap} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.UrlMap|UrlMap} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1194,12 +1186,11 @@ export class RegionUrlMapsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.UrlMap | UrlMap}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.UrlMap|UrlMap}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/region_url_maps.list.js * region_tag:compute_v1_generated_RegionUrlMaps_List_async diff --git a/packages/google-cloud-compute/src/v1/regions_client.ts b/packages/google-cloud-compute/src/v1/regions_client.ts index 6fcb2a0bf41f..24b0d14dfecc 100644 --- a/packages/google-cloud-compute/src/v1/regions_client.ts +++ b/packages/google-cloud-compute/src/v1/regions_client.ts @@ -332,9 +332,8 @@ export class RegionsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Region | Region}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Region|Region}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/regions.get.js * region_tag:compute_v1_generated_Regions_Get_async @@ -427,14 +426,13 @@ export class RegionsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Region | Region}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Region|Region}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -523,13 +521,12 @@ export class RegionsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Region | Region} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Region|Region} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -575,12 +572,11 @@ export class RegionsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Region | Region}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Region|Region}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/regions.list.js * region_tag:compute_v1_generated_Regions_List_async diff --git a/packages/google-cloud-compute/src/v1/reservations_client.ts b/packages/google-cloud-compute/src/v1/reservations_client.ts index 5fd2f6caeed4..c955588f4a2c 100644 --- a/packages/google-cloud-compute/src/v1/reservations_client.ts +++ b/packages/google-cloud-compute/src/v1/reservations_client.ts @@ -354,8 +354,7 @@ export class ReservationsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -474,9 +473,8 @@ export class ReservationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Reservation | Reservation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Reservation|Reservation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/reservations.get.js * region_tag:compute_v1_generated_Reservations_Get_async @@ -567,9 +565,8 @@ export class ReservationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/reservations.get_iam_policy.js * region_tag:compute_v1_generated_Reservations_GetIamPolicy_async @@ -674,8 +671,7 @@ export class ReservationsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -799,8 +795,7 @@ export class ReservationsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -921,9 +916,8 @@ export class ReservationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/reservations.set_iam_policy.js * region_tag:compute_v1_generated_Reservations_SetIamPolicy_async @@ -1026,9 +1020,8 @@ export class ReservationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/reservations.test_iam_permissions.js * region_tag:compute_v1_generated_Reservations_TestIamPermissions_async @@ -1138,8 +1131,7 @@ export class ReservationsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1268,12 +1260,11 @@ export class ReservationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.ReservationsScopedList | ReservationsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.ReservationsScopedList|ReservationsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/reservations.aggregated_list.js * region_tag:compute_v1_generated_Reservations_AggregatedList_async @@ -1325,14 +1316,13 @@ export class ReservationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Reservation | Reservation}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Reservation|Reservation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1424,13 +1414,12 @@ export class ReservationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Reservation | Reservation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Reservation|Reservation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1479,12 +1468,11 @@ export class ReservationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Reservation | Reservation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Reservation|Reservation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/reservations.list.js * region_tag:compute_v1_generated_Reservations_List_async diff --git a/packages/google-cloud-compute/src/v1/resource_policies_client.ts b/packages/google-cloud-compute/src/v1/resource_policies_client.ts index 3b69017b3202..a021872e099a 100644 --- a/packages/google-cloud-compute/src/v1/resource_policies_client.ts +++ b/packages/google-cloud-compute/src/v1/resource_policies_client.ts @@ -246,6 +246,7 @@ export class ResourcePoliciesClient { 'getIamPolicy', 'insert', 'list', + 'patch', 'setIamPolicy', 'testIamPermissions', ]; @@ -352,8 +353,7 @@ export class ResourcePoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -472,9 +472,8 @@ export class ResourcePoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.ResourcePolicy | ResourcePolicy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.ResourcePolicy|ResourcePolicy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/resource_policies.get.js * region_tag:compute_v1_generated_ResourcePolicies_Get_async @@ -571,9 +570,8 @@ export class ResourcePoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/resource_policies.get_iam_policy.js * region_tag:compute_v1_generated_ResourcePolicies_GetIamPolicy_async @@ -678,8 +676,7 @@ export class ResourcePoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -783,6 +780,133 @@ export class ResourcePoliciesClient { } ); } + /** + * Modify the specified resource policy. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.project + * Project ID for this request. + * @param {string} request.region + * Name of the region for this request. + * @param {string} request.requestId + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + * @param {string} request.resourcePolicy + * Id of the resource policy to patch. + * @param {google.cloud.compute.v1.ResourcePolicy} request.resourcePolicyResource + * The body resource for this request + * @param {string} request.updateMask + * update_mask indicates fields to be updated as part of this request. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing + * a long running operation. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } + * for more details and examples. + * This method is considered to be in beta. This means while + * stable it is still a work-in-progress and under active development, + * and might get backwards-incompatible changes at any time. + * `.promise()` is not supported yet. + * @example include:samples/generated/v1/resource_policies.patch.js + * region_tag:compute_v1_generated_ResourcePolicies_Patch_async + */ + patch( + request?: protos.google.cloud.compute.v1.IPatchResourcePolicyRequest, + options?: CallOptions + ): Promise< + [ + LROperation, + protos.google.cloud.compute.v1.IOperation | undefined, + {} | undefined + ] + >; + patch( + request: protos.google.cloud.compute.v1.IPatchResourcePolicyRequest, + options: CallOptions, + callback: Callback< + protos.google.cloud.compute.v1.IOperation, + | protos.google.cloud.compute.v1.IPatchResourcePolicyRequest + | null + | undefined, + {} | null | undefined + > + ): void; + patch( + request: protos.google.cloud.compute.v1.IPatchResourcePolicyRequest, + callback: Callback< + protos.google.cloud.compute.v1.IOperation, + | protos.google.cloud.compute.v1.IPatchResourcePolicyRequest + | null + | undefined, + {} | null | undefined + > + ): void; + patch( + request?: protos.google.cloud.compute.v1.IPatchResourcePolicyRequest, + optionsOrCallback?: + | CallOptions + | Callback< + protos.google.cloud.compute.v1.IOperation, + | protos.google.cloud.compute.v1.IPatchResourcePolicyRequest + | null + | undefined, + {} | null | undefined + >, + callback?: Callback< + protos.google.cloud.compute.v1.IOperation, + | protos.google.cloud.compute.v1.IPatchResourcePolicyRequest + | null + | undefined, + {} | null | undefined + > + ): Promise< + [ + LROperation, + protos.google.cloud.compute.v1.IOperation | undefined, + {} | undefined + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + project: request.project ?? '', + region: request.region ?? '', + resource_policy: request.resourcePolicy ?? '', + }); + this.initialize(); + return this.innerApiCalls + .patch(request, options, callback) + .then( + ([response, operation, rawResponse]: [ + protos.google.cloud.compute.v1.IOperation, + protos.google.cloud.compute.v1.IOperation, + protos.google.cloud.compute.v1.IOperation + ]) => { + return [ + { + latestResponse: response, + done: false, + name: response.id, + metadata: null, + result: {}, + }, + operation, + rawResponse, + ]; + } + ); + } /** * Sets the access control policy on the specified resource. Replaces any existing policy. * @@ -799,9 +923,8 @@ export class ResourcePoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/resource_policies.set_iam_policy.js * region_tag:compute_v1_generated_ResourcePolicies_SetIamPolicy_async @@ -904,9 +1027,8 @@ export class ResourcePoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/resource_policies.test_iam_permissions.js * region_tag:compute_v1_generated_ResourcePolicies_TestIamPermissions_async @@ -1017,12 +1139,11 @@ export class ResourcePoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.ResourcePoliciesScopedList | ResourcePoliciesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.ResourcePoliciesScopedList|ResourcePoliciesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/resource_policies.aggregated_list.js * region_tag:compute_v1_generated_ResourcePolicies_AggregatedList_async @@ -1074,14 +1195,13 @@ export class ResourcePoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.ResourcePolicy | ResourcePolicy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.ResourcePolicy|ResourcePolicy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1173,13 +1293,12 @@ export class ResourcePoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.ResourcePolicy | ResourcePolicy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.ResourcePolicy|ResourcePolicy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1228,12 +1347,11 @@ export class ResourcePoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.ResourcePolicy | ResourcePolicy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.ResourcePolicy|ResourcePolicy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/resource_policies.list.js * region_tag:compute_v1_generated_ResourcePolicies_List_async diff --git a/packages/google-cloud-compute/src/v1/resource_policies_client_config.json b/packages/google-cloud-compute/src/v1/resource_policies_client_config.json index 5e0e41c3d2a8..5989c2b20fe0 100644 --- a/packages/google-cloud-compute/src/v1/resource_policies_client_config.json +++ b/packages/google-cloud-compute/src/v1/resource_policies_client_config.json @@ -44,6 +44,10 @@ "retry_codes_name": "non_idempotent", "retry_params_name": "default" }, + "Patch": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, "SetIamPolicy": { "retry_codes_name": "non_idempotent", "retry_params_name": "default" diff --git a/packages/google-cloud-compute/src/v1/routers_client.ts b/packages/google-cloud-compute/src/v1/routers_client.ts index ded74a5bd537..e8ab148f6336 100644 --- a/packages/google-cloud-compute/src/v1/routers_client.ts +++ b/packages/google-cloud-compute/src/v1/routers_client.ts @@ -359,8 +359,7 @@ export class RoutersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -473,9 +472,8 @@ export class RoutersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Router | Router}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Router|Router}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/routers.get.js * region_tag:compute_v1_generated_Routers_Get_async @@ -562,9 +560,8 @@ export class RoutersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.RouterStatusResponse | RouterStatusResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.RouterStatusResponse|RouterStatusResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/routers.get_router_status.js * region_tag:compute_v1_generated_Routers_GetRouterStatus_async @@ -663,8 +660,7 @@ export class RoutersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -782,8 +778,7 @@ export class RoutersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -896,9 +891,8 @@ export class RoutersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.RoutersPreviewResponse | RoutersPreviewResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.RoutersPreviewResponse|RoutersPreviewResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/routers.preview.js * region_tag:compute_v1_generated_Routers_Preview_async @@ -993,8 +987,7 @@ export class RoutersClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1117,12 +1110,11 @@ export class RoutersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.RoutersScopedList | RoutersScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.RoutersScopedList|RoutersScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/routers.aggregated_list.js * region_tag:compute_v1_generated_Routers_AggregatedList_async @@ -1178,14 +1170,13 @@ export class RoutersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.VmEndpointNatMappings | VmEndpointNatMappings}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.VmEndpointNatMappings|VmEndpointNatMappings}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `getNatMappingInfoAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ getNatMappingInfo( @@ -1290,13 +1281,12 @@ export class RoutersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.VmEndpointNatMappings | VmEndpointNatMappings} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.VmEndpointNatMappings|VmEndpointNatMappings} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `getNatMappingInfoAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ getNatMappingInfoStream( @@ -1350,12 +1340,11 @@ export class RoutersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.VmEndpointNatMappings | VmEndpointNatMappings}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.VmEndpointNatMappings|VmEndpointNatMappings}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/routers.get_nat_mapping_info.js * region_tag:compute_v1_generated_Routers_GetNatMappingInfo_async @@ -1405,14 +1394,13 @@ export class RoutersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Router | Router}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Router|Router}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1504,13 +1492,12 @@ export class RoutersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Router | Router} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Router|Router} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1559,12 +1546,11 @@ export class RoutersClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Router | Router}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Router|Router}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/routers.list.js * region_tag:compute_v1_generated_Routers_List_async diff --git a/packages/google-cloud-compute/src/v1/routes_client.ts b/packages/google-cloud-compute/src/v1/routes_client.ts index 53565cbbac66..88bec9ea07e5 100644 --- a/packages/google-cloud-compute/src/v1/routes_client.ts +++ b/packages/google-cloud-compute/src/v1/routes_client.ts @@ -336,8 +336,7 @@ export class RoutesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -445,9 +444,8 @@ export class RoutesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Route | Route}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Route|Route}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/routes.get.js * region_tag:compute_v1_generated_Routes_Get_async @@ -535,8 +533,7 @@ export class RoutesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -652,14 +649,13 @@ export class RoutesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Route | Route}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Route|Route}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -748,13 +744,12 @@ export class RoutesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Route | Route} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Route|Route} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -800,12 +795,11 @@ export class RoutesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Route | Route}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Route|Route}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/routes.list.js * region_tag:compute_v1_generated_Routes_List_async diff --git a/packages/google-cloud-compute/src/v1/security_policies_client.ts b/packages/google-cloud-compute/src/v1/security_policies_client.ts index a9b7be1487ef..2038908059ea 100644 --- a/packages/google-cloud-compute/src/v1/security_policies_client.ts +++ b/packages/google-cloud-compute/src/v1/security_policies_client.ts @@ -356,8 +356,7 @@ export class SecurityPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -477,8 +476,7 @@ export class SecurityPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -594,9 +592,8 @@ export class SecurityPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SecurityPolicy | SecurityPolicy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SecurityPolicy|SecurityPolicy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/security_policies.get.js * region_tag:compute_v1_generated_SecurityPolicies_Get_async @@ -690,9 +687,8 @@ export class SecurityPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SecurityPolicyRule | SecurityPolicyRule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SecurityPolicyRule|SecurityPolicyRule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/security_policies.get_rule.js * region_tag:compute_v1_generated_SecurityPolicies_GetRule_async @@ -790,8 +786,7 @@ export class SecurityPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -914,9 +909,8 @@ export class SecurityPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SecurityPoliciesListPreconfiguredExpressionSetsResponse | SecurityPoliciesListPreconfiguredExpressionSetsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SecurityPoliciesListPreconfiguredExpressionSetsResponse|SecurityPoliciesListPreconfiguredExpressionSetsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/security_policies.list_preconfigured_expression_sets.js * region_tag:compute_v1_generated_SecurityPolicies_ListPreconfiguredExpressionSets_async @@ -1006,7 +1000,7 @@ export class SecurityPoliciesClient { ); } /** - * Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. + * Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. * * @param {Object} request * The request object that will be sent. @@ -1023,8 +1017,7 @@ export class SecurityPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1129,7 +1122,7 @@ export class SecurityPoliciesClient { ); } /** - * Patches a rule at the specified priority. + * Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask. * * @param {Object} request * The request object that will be sent. @@ -1148,8 +1141,7 @@ export class SecurityPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1269,8 +1261,7 @@ export class SecurityPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1390,8 +1381,7 @@ export class SecurityPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1519,12 +1509,11 @@ export class SecurityPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.SecurityPoliciesScopedList | SecurityPoliciesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.SecurityPoliciesScopedList|SecurityPoliciesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/security_policies.aggregated_list.js * region_tag:compute_v1_generated_SecurityPolicies_AggregatedList_async @@ -1574,14 +1563,13 @@ export class SecurityPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.SecurityPolicy | SecurityPolicy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.SecurityPolicy|SecurityPolicy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1670,13 +1658,12 @@ export class SecurityPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.SecurityPolicy | SecurityPolicy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.SecurityPolicy|SecurityPolicy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1722,12 +1709,11 @@ export class SecurityPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.SecurityPolicy | SecurityPolicy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.SecurityPolicy|SecurityPolicy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/security_policies.list.js * region_tag:compute_v1_generated_SecurityPolicies_List_async diff --git a/packages/google-cloud-compute/src/v1/service_attachments_client.ts b/packages/google-cloud-compute/src/v1/service_attachments_client.ts index 2081b9ad6f6c..bad094a9f4fa 100644 --- a/packages/google-cloud-compute/src/v1/service_attachments_client.ts +++ b/packages/google-cloud-compute/src/v1/service_attachments_client.ts @@ -353,8 +353,7 @@ export class ServiceAttachmentsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -473,9 +472,8 @@ export class ServiceAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.ServiceAttachment | ServiceAttachment}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.ServiceAttachment|ServiceAttachment}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_attachments.get.js * region_tag:compute_v1_generated_ServiceAttachments_Get_async @@ -572,9 +570,8 @@ export class ServiceAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_attachments.get_iam_policy.js * region_tag:compute_v1_generated_ServiceAttachments_GetIamPolicy_async @@ -679,8 +676,7 @@ export class ServiceAttachmentsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -804,8 +800,7 @@ export class ServiceAttachmentsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -926,9 +921,8 @@ export class ServiceAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_attachments.set_iam_policy.js * region_tag:compute_v1_generated_ServiceAttachments_SetIamPolicy_async @@ -1031,9 +1025,8 @@ export class ServiceAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/service_attachments.test_iam_permissions.js * region_tag:compute_v1_generated_ServiceAttachments_TestIamPermissions_async @@ -1144,12 +1137,11 @@ export class ServiceAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.ServiceAttachmentsScopedList | ServiceAttachmentsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.ServiceAttachmentsScopedList|ServiceAttachmentsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/service_attachments.aggregated_list.js * region_tag:compute_v1_generated_ServiceAttachments_AggregatedList_async @@ -1201,14 +1193,13 @@ export class ServiceAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.ServiceAttachment | ServiceAttachment}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.ServiceAttachment|ServiceAttachment}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1302,13 +1293,12 @@ export class ServiceAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.ServiceAttachment | ServiceAttachment} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.ServiceAttachment|ServiceAttachment} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1357,12 +1347,11 @@ export class ServiceAttachmentsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.ServiceAttachment | ServiceAttachment}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.ServiceAttachment|ServiceAttachment}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/service_attachments.list.js * region_tag:compute_v1_generated_ServiceAttachments_List_async diff --git a/packages/google-cloud-compute/src/v1/snapshots_client.ts b/packages/google-cloud-compute/src/v1/snapshots_client.ts index c11bde14c06e..7f8505dac5e7 100644 --- a/packages/google-cloud-compute/src/v1/snapshots_client.ts +++ b/packages/google-cloud-compute/src/v1/snapshots_client.ts @@ -345,8 +345,7 @@ export class SnapshotsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -456,9 +455,8 @@ export class SnapshotsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Snapshot | Snapshot}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Snapshot|Snapshot}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/snapshots.get.js * region_tag:compute_v1_generated_Snapshots_Get_async @@ -544,9 +542,8 @@ export class SnapshotsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/snapshots.get_iam_policy.js * region_tag:compute_v1_generated_Snapshots_GetIamPolicy_async @@ -642,8 +639,7 @@ export class SnapshotsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -754,9 +750,8 @@ export class SnapshotsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/snapshots.set_iam_policy.js * region_tag:compute_v1_generated_Snapshots_SetIamPolicy_async @@ -852,8 +847,7 @@ export class SnapshotsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -971,9 +965,8 @@ export class SnapshotsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/snapshots.test_iam_permissions.js * region_tag:compute_v1_generated_Snapshots_TestIamPermissions_async @@ -1080,14 +1073,13 @@ export class SnapshotsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Snapshot | Snapshot}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Snapshot|Snapshot}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1176,13 +1168,12 @@ export class SnapshotsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Snapshot | Snapshot} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Snapshot|Snapshot} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1228,12 +1219,11 @@ export class SnapshotsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Snapshot | Snapshot}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Snapshot|Snapshot}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/snapshots.list.js * region_tag:compute_v1_generated_Snapshots_List_async diff --git a/packages/google-cloud-compute/src/v1/ssl_certificates_client.ts b/packages/google-cloud-compute/src/v1/ssl_certificates_client.ts index 82f15591e0df..b4467cde0934 100644 --- a/packages/google-cloud-compute/src/v1/ssl_certificates_client.ts +++ b/packages/google-cloud-compute/src/v1/ssl_certificates_client.ts @@ -347,8 +347,7 @@ export class SslCertificatesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -464,9 +463,8 @@ export class SslCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SslCertificate | SslCertificate}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SslCertificate|SslCertificate}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/ssl_certificates.get.js * region_tag:compute_v1_generated_SslCertificates_Get_async @@ -562,8 +560,7 @@ export class SslCertificatesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -690,12 +687,11 @@ export class SslCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.SslCertificatesScopedList | SslCertificatesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.SslCertificatesScopedList|SslCertificatesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/ssl_certificates.aggregated_list.js * region_tag:compute_v1_generated_SslCertificates_AggregatedList_async @@ -745,14 +741,13 @@ export class SslCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.SslCertificate | SslCertificate}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.SslCertificate|SslCertificate}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -841,13 +836,12 @@ export class SslCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.SslCertificate | SslCertificate} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.SslCertificate|SslCertificate} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -893,12 +887,11 @@ export class SslCertificatesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.SslCertificate | SslCertificate}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.SslCertificate|SslCertificate}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/ssl_certificates.list.js * region_tag:compute_v1_generated_SslCertificates_List_async diff --git a/packages/google-cloud-compute/src/v1/ssl_policies_client.ts b/packages/google-cloud-compute/src/v1/ssl_policies_client.ts index 61c13bf0ebf0..c577d1bce9fc 100644 --- a/packages/google-cloud-compute/src/v1/ssl_policies_client.ts +++ b/packages/google-cloud-compute/src/v1/ssl_policies_client.ts @@ -349,8 +349,7 @@ export class SslPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -460,9 +459,8 @@ export class SslPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SslPolicy | SslPolicy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SslPolicy|SslPolicy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/ssl_policies.get.js * region_tag:compute_v1_generated_SslPolicies_Get_async @@ -552,8 +550,7 @@ export class SslPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -670,9 +667,8 @@ export class SslPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.SslPoliciesListAvailableFeaturesResponse | SslPoliciesListAvailableFeaturesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.SslPoliciesListAvailableFeaturesResponse|SslPoliciesListAvailableFeaturesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/ssl_policies.list_available_features.js * region_tag:compute_v1_generated_SslPolicies_ListAvailableFeatures_async @@ -775,8 +771,7 @@ export class SslPoliciesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -898,12 +893,11 @@ export class SslPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.SslPoliciesScopedList | SslPoliciesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.SslPoliciesScopedList|SslPoliciesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/ssl_policies.aggregated_list.js * region_tag:compute_v1_generated_SslPolicies_AggregatedList_async @@ -953,14 +947,13 @@ export class SslPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.SslPolicy | SslPolicy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.SslPolicy|SslPolicy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1049,13 +1042,12 @@ export class SslPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.SslPolicy | SslPolicy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.SslPolicy|SslPolicy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1101,12 +1093,11 @@ export class SslPoliciesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.SslPolicy | SslPolicy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.SslPolicy|SslPolicy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/ssl_policies.list.js * region_tag:compute_v1_generated_SslPolicies_List_async diff --git a/packages/google-cloud-compute/src/v1/subnetworks_client.ts b/packages/google-cloud-compute/src/v1/subnetworks_client.ts index 312fa6dc2eea..7291c9b43067 100644 --- a/packages/google-cloud-compute/src/v1/subnetworks_client.ts +++ b/packages/google-cloud-compute/src/v1/subnetworks_client.ts @@ -361,8 +361,7 @@ export class SubnetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -487,8 +486,7 @@ export class SubnetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -607,9 +605,8 @@ export class SubnetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Subnetwork | Subnetwork}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Subnetwork|Subnetwork}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/subnetworks.get.js * region_tag:compute_v1_generated_Subnetworks_Get_async @@ -700,9 +697,8 @@ export class SubnetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/subnetworks.get_iam_policy.js * region_tag:compute_v1_generated_Subnetworks_GetIamPolicy_async @@ -801,8 +797,7 @@ export class SubnetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -928,8 +923,7 @@ export class SubnetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1044,9 +1038,8 @@ export class SubnetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Policy | Policy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Policy|Policy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/subnetworks.set_iam_policy.js * region_tag:compute_v1_generated_Subnetworks_SetIamPolicy_async @@ -1147,8 +1140,7 @@ export class SubnetworksClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1269,9 +1261,8 @@ export class SubnetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/subnetworks.test_iam_permissions.js * region_tag:compute_v1_generated_Subnetworks_TestIamPermissions_async @@ -1382,12 +1373,11 @@ export class SubnetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.SubnetworksScopedList | SubnetworksScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.SubnetworksScopedList|SubnetworksScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/subnetworks.aggregated_list.js * region_tag:compute_v1_generated_Subnetworks_AggregatedList_async @@ -1439,14 +1429,13 @@ export class SubnetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Subnetwork | Subnetwork}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Subnetwork|Subnetwork}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1538,13 +1527,12 @@ export class SubnetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Subnetwork | Subnetwork} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Subnetwork|Subnetwork} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1593,12 +1581,11 @@ export class SubnetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Subnetwork | Subnetwork}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Subnetwork|Subnetwork}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/subnetworks.list.js * region_tag:compute_v1_generated_Subnetworks_List_async @@ -1645,14 +1632,13 @@ export class SubnetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.UsableSubnetwork | UsableSubnetwork}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.UsableSubnetwork|UsableSubnetwork}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listUsableAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listUsable( @@ -1749,13 +1735,12 @@ export class SubnetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.UsableSubnetwork | UsableSubnetwork} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.UsableSubnetwork|UsableSubnetwork} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listUsableAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listUsableStream( @@ -1801,12 +1786,11 @@ export class SubnetworksClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.UsableSubnetwork | UsableSubnetwork}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.UsableSubnetwork|UsableSubnetwork}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/subnetworks.list_usable.js * region_tag:compute_v1_generated_Subnetworks_ListUsable_async diff --git a/packages/google-cloud-compute/src/v1/target_grpc_proxies_client.ts b/packages/google-cloud-compute/src/v1/target_grpc_proxies_client.ts index 51dd2679f837..085f2ead2769 100644 --- a/packages/google-cloud-compute/src/v1/target_grpc_proxies_client.ts +++ b/packages/google-cloud-compute/src/v1/target_grpc_proxies_client.ts @@ -342,8 +342,7 @@ export class TargetGrpcProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -459,9 +458,8 @@ export class TargetGrpcProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetGrpcProxy | TargetGrpcProxy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetGrpcProxy|TargetGrpcProxy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/target_grpc_proxies.get.js * region_tag:compute_v1_generated_TargetGrpcProxies_Get_async @@ -557,8 +555,7 @@ export class TargetGrpcProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -679,8 +676,7 @@ export class TargetGrpcProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -805,14 +801,13 @@ export class TargetGrpcProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.TargetGrpcProxy | TargetGrpcProxy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.TargetGrpcProxy|TargetGrpcProxy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -903,13 +898,12 @@ export class TargetGrpcProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.TargetGrpcProxy | TargetGrpcProxy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.TargetGrpcProxy|TargetGrpcProxy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -955,12 +949,11 @@ export class TargetGrpcProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.TargetGrpcProxy | TargetGrpcProxy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.TargetGrpcProxy|TargetGrpcProxy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_grpc_proxies.list.js * region_tag:compute_v1_generated_TargetGrpcProxies_List_async diff --git a/packages/google-cloud-compute/src/v1/target_http_proxies_client.ts b/packages/google-cloud-compute/src/v1/target_http_proxies_client.ts index 0f5e6ba3e863..4b1449a148b0 100644 --- a/packages/google-cloud-compute/src/v1/target_http_proxies_client.ts +++ b/packages/google-cloud-compute/src/v1/target_http_proxies_client.ts @@ -349,8 +349,7 @@ export class TargetHttpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -466,9 +465,8 @@ export class TargetHttpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetHttpProxy | TargetHttpProxy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetHttpProxy|TargetHttpProxy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/target_http_proxies.get.js * region_tag:compute_v1_generated_TargetHttpProxies_Get_async @@ -564,8 +562,7 @@ export class TargetHttpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -686,8 +683,7 @@ export class TargetHttpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -809,8 +805,7 @@ export class TargetHttpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -938,12 +933,11 @@ export class TargetHttpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.TargetHttpProxiesScopedList | TargetHttpProxiesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.TargetHttpProxiesScopedList|TargetHttpProxiesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_http_proxies.aggregated_list.js * region_tag:compute_v1_generated_TargetHttpProxies_AggregatedList_async @@ -993,14 +987,13 @@ export class TargetHttpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.TargetHttpProxy | TargetHttpProxy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.TargetHttpProxy|TargetHttpProxy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1091,13 +1084,12 @@ export class TargetHttpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.TargetHttpProxy | TargetHttpProxy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.TargetHttpProxy|TargetHttpProxy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1143,12 +1135,11 @@ export class TargetHttpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.TargetHttpProxy | TargetHttpProxy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.TargetHttpProxy|TargetHttpProxy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_http_proxies.list.js * region_tag:compute_v1_generated_TargetHttpProxies_List_async diff --git a/packages/google-cloud-compute/src/v1/target_https_proxies_client.ts b/packages/google-cloud-compute/src/v1/target_https_proxies_client.ts index f0276bba37db..6d8859ec4261 100644 --- a/packages/google-cloud-compute/src/v1/target_https_proxies_client.ts +++ b/packages/google-cloud-compute/src/v1/target_https_proxies_client.ts @@ -353,8 +353,7 @@ export class TargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -470,9 +469,8 @@ export class TargetHttpsProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetHttpsProxy | TargetHttpsProxy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetHttpsProxy|TargetHttpsProxy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/target_https_proxies.get.js * region_tag:compute_v1_generated_TargetHttpsProxies_Get_async @@ -568,8 +566,7 @@ export class TargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -690,8 +687,7 @@ export class TargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -813,8 +809,7 @@ export class TargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -936,8 +931,7 @@ export class TargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1059,8 +1053,7 @@ export class TargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1182,8 +1175,7 @@ export class TargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1305,8 +1297,7 @@ export class TargetHttpsProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1434,12 +1425,11 @@ export class TargetHttpsProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.TargetHttpsProxiesScopedList | TargetHttpsProxiesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.TargetHttpsProxiesScopedList|TargetHttpsProxiesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_https_proxies.aggregated_list.js * region_tag:compute_v1_generated_TargetHttpsProxies_AggregatedList_async @@ -1489,14 +1479,13 @@ export class TargetHttpsProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.TargetHttpsProxy | TargetHttpsProxy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.TargetHttpsProxy|TargetHttpsProxy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1587,13 +1576,12 @@ export class TargetHttpsProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.TargetHttpsProxy | TargetHttpsProxy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.TargetHttpsProxy|TargetHttpsProxy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1639,12 +1627,11 @@ export class TargetHttpsProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.TargetHttpsProxy | TargetHttpsProxy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.TargetHttpsProxy|TargetHttpsProxy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_https_proxies.list.js * region_tag:compute_v1_generated_TargetHttpsProxies_List_async diff --git a/packages/google-cloud-compute/src/v1/target_instances_client.ts b/packages/google-cloud-compute/src/v1/target_instances_client.ts index 52cc58cbc602..586c214237df 100644 --- a/packages/google-cloud-compute/src/v1/target_instances_client.ts +++ b/packages/google-cloud-compute/src/v1/target_instances_client.ts @@ -349,8 +349,7 @@ export class TargetInstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -469,9 +468,8 @@ export class TargetInstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetInstance | TargetInstance}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetInstance|TargetInstance}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/target_instances.get.js * region_tag:compute_v1_generated_TargetInstances_Get_async @@ -570,8 +568,7 @@ export class TargetInstancesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -699,12 +696,11 @@ export class TargetInstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.TargetInstancesScopedList | TargetInstancesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.TargetInstancesScopedList|TargetInstancesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_instances.aggregated_list.js * region_tag:compute_v1_generated_TargetInstances_AggregatedList_async @@ -756,14 +752,13 @@ export class TargetInstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.TargetInstance | TargetInstance}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.TargetInstance|TargetInstance}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -855,13 +850,12 @@ export class TargetInstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.TargetInstance | TargetInstance} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.TargetInstance|TargetInstance} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -910,12 +904,11 @@ export class TargetInstancesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.TargetInstance | TargetInstance}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.TargetInstance|TargetInstance}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_instances.list.js * region_tag:compute_v1_generated_TargetInstances_List_async diff --git a/packages/google-cloud-compute/src/v1/target_pools_client.ts b/packages/google-cloud-compute/src/v1/target_pools_client.ts index 78b9d74be324..3a94c91feee6 100644 --- a/packages/google-cloud-compute/src/v1/target_pools_client.ts +++ b/packages/google-cloud-compute/src/v1/target_pools_client.ts @@ -357,8 +357,7 @@ export class TargetPoolsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -483,8 +482,7 @@ export class TargetPoolsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -607,8 +605,7 @@ export class TargetPoolsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -727,9 +724,8 @@ export class TargetPoolsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetPool | TargetPool}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetPool|TargetPool}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/target_pools.get.js * region_tag:compute_v1_generated_TargetPools_Get_async @@ -820,9 +816,8 @@ export class TargetPoolsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetPoolInstanceHealth | TargetPoolInstanceHealth}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetPoolInstanceHealth|TargetPoolInstanceHealth}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/target_pools.get_health.js * region_tag:compute_v1_generated_TargetPools_GetHealth_async @@ -921,8 +916,7 @@ export class TargetPoolsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1046,8 +1040,7 @@ export class TargetPoolsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1172,8 +1165,7 @@ export class TargetPoolsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1300,8 +1292,7 @@ export class TargetPoolsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1430,12 +1421,11 @@ export class TargetPoolsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.TargetPoolsScopedList | TargetPoolsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.TargetPoolsScopedList|TargetPoolsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_pools.aggregated_list.js * region_tag:compute_v1_generated_TargetPools_AggregatedList_async @@ -1487,14 +1477,13 @@ export class TargetPoolsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.TargetPool | TargetPool}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.TargetPool|TargetPool}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1586,13 +1575,12 @@ export class TargetPoolsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.TargetPool | TargetPool} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.TargetPool|TargetPool} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1641,12 +1629,11 @@ export class TargetPoolsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.TargetPool | TargetPool}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.TargetPool|TargetPool}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_pools.list.js * region_tag:compute_v1_generated_TargetPools_List_async diff --git a/packages/google-cloud-compute/src/v1/target_ssl_proxies_client.ts b/packages/google-cloud-compute/src/v1/target_ssl_proxies_client.ts index c70f90fb2c96..7b4c63f060b4 100644 --- a/packages/google-cloud-compute/src/v1/target_ssl_proxies_client.ts +++ b/packages/google-cloud-compute/src/v1/target_ssl_proxies_client.ts @@ -346,8 +346,7 @@ export class TargetSslProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -463,9 +462,8 @@ export class TargetSslProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetSslProxy | TargetSslProxy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetSslProxy|TargetSslProxy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/target_ssl_proxies.get.js * region_tag:compute_v1_generated_TargetSslProxies_Get_async @@ -561,8 +559,7 @@ export class TargetSslProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -683,8 +680,7 @@ export class TargetSslProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -806,8 +802,7 @@ export class TargetSslProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -929,8 +924,7 @@ export class TargetSslProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1052,8 +1046,7 @@ export class TargetSslProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1175,8 +1168,7 @@ export class TargetSslProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1301,14 +1293,13 @@ export class TargetSslProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.TargetSslProxy | TargetSslProxy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.TargetSslProxy|TargetSslProxy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1397,13 +1388,12 @@ export class TargetSslProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.TargetSslProxy | TargetSslProxy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.TargetSslProxy|TargetSslProxy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1449,12 +1439,11 @@ export class TargetSslProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.TargetSslProxy | TargetSslProxy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.TargetSslProxy|TargetSslProxy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_ssl_proxies.list.js * region_tag:compute_v1_generated_TargetSslProxies_List_async diff --git a/packages/google-cloud-compute/src/v1/target_tcp_proxies_client.ts b/packages/google-cloud-compute/src/v1/target_tcp_proxies_client.ts index 281a34631438..109dc9a63cc5 100644 --- a/packages/google-cloud-compute/src/v1/target_tcp_proxies_client.ts +++ b/packages/google-cloud-compute/src/v1/target_tcp_proxies_client.ts @@ -349,8 +349,7 @@ export class TargetTcpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -466,9 +465,8 @@ export class TargetTcpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetTcpProxy | TargetTcpProxy}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetTcpProxy|TargetTcpProxy}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/target_tcp_proxies.get.js * region_tag:compute_v1_generated_TargetTcpProxies_Get_async @@ -564,8 +562,7 @@ export class TargetTcpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -686,8 +683,7 @@ export class TargetTcpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -809,8 +805,7 @@ export class TargetTcpProxiesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -938,12 +933,11 @@ export class TargetTcpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.TargetTcpProxiesScopedList | TargetTcpProxiesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.TargetTcpProxiesScopedList|TargetTcpProxiesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_tcp_proxies.aggregated_list.js * region_tag:compute_v1_generated_TargetTcpProxies_AggregatedList_async @@ -993,14 +987,13 @@ export class TargetTcpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.TargetTcpProxy | TargetTcpProxy}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.TargetTcpProxy|TargetTcpProxy}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1089,13 +1082,12 @@ export class TargetTcpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.TargetTcpProxy | TargetTcpProxy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.TargetTcpProxy|TargetTcpProxy} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1141,12 +1133,11 @@ export class TargetTcpProxiesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.TargetTcpProxy | TargetTcpProxy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.TargetTcpProxy|TargetTcpProxy}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_tcp_proxies.list.js * region_tag:compute_v1_generated_TargetTcpProxies_List_async diff --git a/packages/google-cloud-compute/src/v1/target_vpn_gateways_client.ts b/packages/google-cloud-compute/src/v1/target_vpn_gateways_client.ts index b650a54edb67..655c57130841 100644 --- a/packages/google-cloud-compute/src/v1/target_vpn_gateways_client.ts +++ b/packages/google-cloud-compute/src/v1/target_vpn_gateways_client.ts @@ -350,8 +350,7 @@ export class TargetVpnGatewaysClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -470,9 +469,8 @@ export class TargetVpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TargetVpnGateway | TargetVpnGateway}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TargetVpnGateway|TargetVpnGateway}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/target_vpn_gateways.get.js * region_tag:compute_v1_generated_TargetVpnGateways_Get_async @@ -571,8 +569,7 @@ export class TargetVpnGatewaysClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -696,8 +693,7 @@ export class TargetVpnGatewaysClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -826,12 +822,11 @@ export class TargetVpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.TargetVpnGatewaysScopedList | TargetVpnGatewaysScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.TargetVpnGatewaysScopedList|TargetVpnGatewaysScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_vpn_gateways.aggregated_list.js * region_tag:compute_v1_generated_TargetVpnGateways_AggregatedList_async @@ -883,14 +878,13 @@ export class TargetVpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.TargetVpnGateway | TargetVpnGateway}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.TargetVpnGateway|TargetVpnGateway}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -984,13 +978,12 @@ export class TargetVpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.TargetVpnGateway | TargetVpnGateway} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.TargetVpnGateway|TargetVpnGateway} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1039,12 +1032,11 @@ export class TargetVpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.TargetVpnGateway | TargetVpnGateway}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.TargetVpnGateway|TargetVpnGateway}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/target_vpn_gateways.list.js * region_tag:compute_v1_generated_TargetVpnGateways_List_async diff --git a/packages/google-cloud-compute/src/v1/url_maps_client.ts b/packages/google-cloud-compute/src/v1/url_maps_client.ts index d72db073e494..4f1db208526f 100644 --- a/packages/google-cloud-compute/src/v1/url_maps_client.ts +++ b/packages/google-cloud-compute/src/v1/url_maps_client.ts @@ -351,8 +351,7 @@ export class UrlMapsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -462,9 +461,8 @@ export class UrlMapsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.UrlMap | UrlMap}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.UrlMap|UrlMap}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/url_maps.get.js * region_tag:compute_v1_generated_UrlMaps_Get_async @@ -552,8 +550,7 @@ export class UrlMapsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -668,8 +665,7 @@ export class UrlMapsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -791,8 +787,7 @@ export class UrlMapsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -906,8 +901,7 @@ export class UrlMapsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -1019,9 +1013,8 @@ export class UrlMapsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.UrlMapsValidateResponse | UrlMapsValidateResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.UrlMapsValidateResponse|UrlMapsValidateResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/url_maps.validate.js * region_tag:compute_v1_generated_UrlMaps_Validate_async @@ -1119,12 +1112,11 @@ export class UrlMapsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.UrlMapsScopedList | UrlMapsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.UrlMapsScopedList|UrlMapsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/url_maps.aggregated_list.js * region_tag:compute_v1_generated_UrlMaps_AggregatedList_async @@ -1174,14 +1166,13 @@ export class UrlMapsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.UrlMap | UrlMap}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.UrlMap|UrlMap}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1270,13 +1261,12 @@ export class UrlMapsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.UrlMap | UrlMap} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.UrlMap|UrlMap} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1322,12 +1312,11 @@ export class UrlMapsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.UrlMap | UrlMap}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.UrlMap|UrlMap}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/url_maps.list.js * region_tag:compute_v1_generated_UrlMaps_List_async diff --git a/packages/google-cloud-compute/src/v1/vpn_gateways_client.ts b/packages/google-cloud-compute/src/v1/vpn_gateways_client.ts index 4c194ca17f92..b2984f8c6c74 100644 --- a/packages/google-cloud-compute/src/v1/vpn_gateways_client.ts +++ b/packages/google-cloud-compute/src/v1/vpn_gateways_client.ts @@ -352,8 +352,7 @@ export class VpnGatewaysClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -472,9 +471,8 @@ export class VpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.VpnGateway | VpnGateway}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.VpnGateway|VpnGateway}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vpn_gateways.get.js * region_tag:compute_v1_generated_VpnGateways_Get_async @@ -563,9 +561,8 @@ export class VpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.VpnGatewaysGetStatusResponse | VpnGatewaysGetStatusResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.VpnGatewaysGetStatusResponse|VpnGatewaysGetStatusResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vpn_gateways.get_status.js * region_tag:compute_v1_generated_VpnGateways_GetStatus_async @@ -664,8 +661,7 @@ export class VpnGatewaysClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -789,8 +785,7 @@ export class VpnGatewaysClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -911,9 +906,8 @@ export class VpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.TestPermissionsResponse | TestPermissionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.TestPermissionsResponse|TestPermissionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vpn_gateways.test_iam_permissions.js * region_tag:compute_v1_generated_VpnGateways_TestIamPermissions_async @@ -1024,12 +1018,11 @@ export class VpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.VpnGatewaysScopedList | VpnGatewaysScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.VpnGatewaysScopedList|VpnGatewaysScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/vpn_gateways.aggregated_list.js * region_tag:compute_v1_generated_VpnGateways_AggregatedList_async @@ -1081,14 +1074,13 @@ export class VpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.VpnGateway | VpnGateway}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.VpnGateway|VpnGateway}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -1180,13 +1172,12 @@ export class VpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.VpnGateway | VpnGateway} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.VpnGateway|VpnGateway} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1235,12 +1226,11 @@ export class VpnGatewaysClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.VpnGateway | VpnGateway}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.VpnGateway|VpnGateway}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/vpn_gateways.list.js * region_tag:compute_v1_generated_VpnGateways_List_async diff --git a/packages/google-cloud-compute/src/v1/vpn_tunnels_client.ts b/packages/google-cloud-compute/src/v1/vpn_tunnels_client.ts index fa8bc8c42f61..77298bdf2d96 100644 --- a/packages/google-cloud-compute/src/v1/vpn_tunnels_client.ts +++ b/packages/google-cloud-compute/src/v1/vpn_tunnels_client.ts @@ -350,8 +350,7 @@ export class VpnTunnelsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -464,9 +463,8 @@ export class VpnTunnelsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.VpnTunnel | VpnTunnel}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.VpnTunnel|VpnTunnel}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vpn_tunnels.get.js * region_tag:compute_v1_generated_VpnTunnels_Get_async @@ -559,8 +557,7 @@ export class VpnTunnelsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -678,8 +675,7 @@ export class VpnTunnelsClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -808,12 +804,11 @@ export class VpnTunnelsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1.VpnTunnelsScopedList | VpnTunnelsScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1.VpnTunnelsScopedList|VpnTunnelsScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/vpn_tunnels.aggregated_list.js * region_tag:compute_v1_generated_VpnTunnels_AggregatedList_async @@ -865,14 +860,13 @@ export class VpnTunnelsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.VpnTunnel | VpnTunnel}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.VpnTunnel|VpnTunnel}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -964,13 +958,12 @@ export class VpnTunnelsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.VpnTunnel | VpnTunnel} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.VpnTunnel|VpnTunnel} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -1019,12 +1012,11 @@ export class VpnTunnelsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.VpnTunnel | VpnTunnel}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.VpnTunnel|VpnTunnel}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/vpn_tunnels.list.js * region_tag:compute_v1_generated_VpnTunnels_List_async diff --git a/packages/google-cloud-compute/src/v1/zone_operations_client.ts b/packages/google-cloud-compute/src/v1/zone_operations_client.ts index 9670cc9e1f9a..10c78b6a87cb 100644 --- a/packages/google-cloud-compute/src/v1/zone_operations_client.ts +++ b/packages/google-cloud-compute/src/v1/zone_operations_client.ts @@ -333,9 +333,8 @@ export class ZoneOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.DeleteZoneOperationResponse | DeleteZoneOperationResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.DeleteZoneOperationResponse|DeleteZoneOperationResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/zone_operations.delete.js * region_tag:compute_v1_generated_ZoneOperations_Delete_async @@ -430,9 +429,8 @@ export class ZoneOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Operation | Operation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Operation|Operation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/zone_operations.get.js * region_tag:compute_v1_generated_ZoneOperations_Get_async @@ -527,9 +525,8 @@ export class ZoneOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Operation | Operation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Operation|Operation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/zone_operations.wait.js * region_tag:compute_v1_generated_ZoneOperations_Wait_async @@ -633,14 +630,13 @@ export class ZoneOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Operation | Operation}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Operation|Operation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -732,13 +728,12 @@ export class ZoneOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Operation | Operation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Operation|Operation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -787,12 +782,11 @@ export class ZoneOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Operation | Operation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Operation|Operation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/zone_operations.list.js * region_tag:compute_v1_generated_ZoneOperations_List_async diff --git a/packages/google-cloud-compute/src/v1/zones_client.ts b/packages/google-cloud-compute/src/v1/zones_client.ts index c57c4f4bc5a0..17d4dd74762c 100644 --- a/packages/google-cloud-compute/src/v1/zones_client.ts +++ b/packages/google-cloud-compute/src/v1/zones_client.ts @@ -332,9 +332,8 @@ export class ZonesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1.Zone | Zone}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1.Zone|Zone}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/zones.get.js * region_tag:compute_v1_generated_Zones_Get_async @@ -427,14 +426,13 @@ export class ZonesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1.Zone | Zone}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1.Zone|Zone}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -523,13 +521,12 @@ export class ZonesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1.Zone | Zone} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1.Zone|Zone} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -575,12 +572,11 @@ export class ZonesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1.Zone | Zone}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1.Zone|Zone}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/zones.list.js * region_tag:compute_v1_generated_Zones_List_async diff --git a/packages/google-cloud-compute/src/v1small/addresses_client.ts b/packages/google-cloud-compute/src/v1small/addresses_client.ts index 1c2dd7c9bbf4..2acb91227707 100644 --- a/packages/google-cloud-compute/src/v1small/addresses_client.ts +++ b/packages/google-cloud-compute/src/v1small/addresses_client.ts @@ -350,8 +350,7 @@ export class AddressesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -478,8 +477,7 @@ export class AddressesClient { * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, @@ -615,12 +613,11 @@ export class AddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * as tuple [string, {@link google.cloud.compute.v1small.AddressesScopedList | AddressesScopedList}]. The API will be called under the hood as needed, once per the page, + * as tuple [string, {@link protos.google.cloud.compute.v1small.AddressesScopedList|AddressesScopedList}]. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1small/addresses.aggregated_list.js * region_tag:compute_v1small_generated_Addresses_AggregatedList_async @@ -680,14 +677,13 @@ export class AddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.compute.v1small.Address | Address}. + * The first element of the array is Array of {@link protos.google.cloud.compute.v1small.Address|Address}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list( @@ -787,13 +783,12 @@ export class AddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.compute.v1small.Address | Address} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.compute.v1small.Address|Address} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStream( @@ -850,12 +845,11 @@ export class AddressesClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.compute.v1small.Address | Address}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.compute.v1small.Address|Address}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1small/addresses.list.js * region_tag:compute_v1small_generated_Addresses_List_async diff --git a/packages/google-cloud-compute/src/v1small/region_operations_client.ts b/packages/google-cloud-compute/src/v1small/region_operations_client.ts index 81afc55e9da3..dab084a8c375 100644 --- a/packages/google-cloud-compute/src/v1small/region_operations_client.ts +++ b/packages/google-cloud-compute/src/v1small/region_operations_client.ts @@ -321,9 +321,8 @@ export class RegionOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1small.Operation | Operation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1small.Operation|Operation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1small/region_operations.get.js * region_tag:compute_v1small_generated_RegionOperations_Get_async @@ -428,9 +427,8 @@ export class RegionOperationsClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.compute.v1small.Operation | Operation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.compute.v1small.Operation|Operation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1small/region_operations.wait.js * region_tag:compute_v1small_generated_RegionOperations_Wait_async diff --git a/packages/google-cloud-compute/test/gapic_resource_policies_v1.ts b/packages/google-cloud-compute/test/gapic_resource_policies_v1.ts index cb3e946fca17..c6b4f223b0e9 100644 --- a/packages/google-cloud-compute/test/gapic_resource_policies_v1.ts +++ b/packages/google-cloud-compute/test/gapic_resource_policies_v1.ts @@ -887,6 +887,169 @@ describe('v1.ResourcePoliciesClient', () => { }); }); + describe('patch', () => { + it('invokes patch without error', async () => { + const client = new resourcepoliciesModule.v1.ResourcePoliciesClient({ + auth: googleAuth, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.compute.v1.PatchResourcePolicyRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['project'] + ); + request.project = defaultValue1; + const defaultValue2 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['region'] + ); + request.region = defaultValue2; + const defaultValue3 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['resourcePolicy'] + ); + request.resourcePolicy = defaultValue3; + const expectedHeaderRequestParams = `project=${defaultValue1}®ion=${defaultValue2}&resource_policy=${defaultValue3}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.compute.v1.Operation() + ); + client.innerApiCalls.patch = stubSimpleCall(expectedResponse); + const [response] = await client.patch(request); + assert.deepStrictEqual(response.latestResponse, expectedResponse); + const actualRequest = (client.innerApiCalls.patch as SinonStub).getCall(0) + .args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.patch as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes patch without error using callback', async () => { + const client = new resourcepoliciesModule.v1.ResourcePoliciesClient({ + auth: googleAuth, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.compute.v1.PatchResourcePolicyRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['project'] + ); + request.project = defaultValue1; + const defaultValue2 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['region'] + ); + request.region = defaultValue2; + const defaultValue3 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['resourcePolicy'] + ); + request.resourcePolicy = defaultValue3; + const expectedHeaderRequestParams = `project=${defaultValue1}®ion=${defaultValue2}&resource_policy=${defaultValue3}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.compute.v1.Operation() + ); + client.innerApiCalls.patch = stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.patch( + request, + ( + err?: Error | null, + result?: protos.google.cloud.compute.v1.IOperation | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = (client.innerApiCalls.patch as SinonStub).getCall(0) + .args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.patch as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes patch with error', async () => { + const client = new resourcepoliciesModule.v1.ResourcePoliciesClient({ + auth: googleAuth, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.compute.v1.PatchResourcePolicyRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['project'] + ); + request.project = defaultValue1; + const defaultValue2 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['region'] + ); + request.region = defaultValue2; + const defaultValue3 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['resourcePolicy'] + ); + request.resourcePolicy = defaultValue3; + const expectedHeaderRequestParams = `project=${defaultValue1}®ion=${defaultValue2}&resource_policy=${defaultValue3}`; + const expectedError = new Error('expected'); + client.innerApiCalls.patch = stubSimpleCall(undefined, expectedError); + await assert.rejects(client.patch(request), expectedError); + const actualRequest = (client.innerApiCalls.patch as SinonStub).getCall(0) + .args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.patch as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes patch with closed client', async () => { + const client = new resourcepoliciesModule.v1.ResourcePoliciesClient({ + auth: googleAuth, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.compute.v1.PatchResourcePolicyRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['project'] + ); + request.project = defaultValue1; + const defaultValue2 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['region'] + ); + request.region = defaultValue2; + const defaultValue3 = getTypeDefaultValue( + '.google.cloud.compute.v1.PatchResourcePolicyRequest', + ['resourcePolicy'] + ); + request.resourcePolicy = defaultValue3; + const expectedError = new Error('The client has already been closed.'); + client.close(); + await assert.rejects(client.patch(request), expectedError); + }); + }); + describe('setIamPolicy', () => { it('invokes setIamPolicy without error', async () => { const client = new resourcepoliciesModule.v1.ResourcePoliciesClient({