Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@maxim_mazurok/gapi.client.cloudprofiler-v2

Package Overview
Dependencies
Maintainers
1
Versions
76
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@maxim_mazurok/gapi.client.cloudprofiler-v2 - npm Package Compare versions

Comparing version 0.0.20231106 to 0.0.20231127

560

index.d.ts

@@ -12,3 +12,3 @@ /* Type definitions for non-npm package Cloud Profiler API v2 0.0 */

// Generated from: https://cloudprofiler.googleapis.com/$discovery/rest?version=v2
// Revision: 20231106
// Revision: 20231127

@@ -18,336 +18,230 @@ /// <reference types="gapi.client" />

declare namespace gapi.client {
/** Load Cloud Profiler API v2 */
function load(urlOrObject: "https://cloudprofiler.googleapis.com/$discovery/rest?version=v2"): Promise<void>;
/** @deprecated Please load APIs with discovery documents. */
function load(name: "cloudprofiler", version: "v2"): Promise<void>;
/** @deprecated Please load APIs with discovery documents. */
function load(name: "cloudprofiler", version: "v2", callback: () => any): void;
/** Load Cloud Profiler API v2 */
function load(
urlOrObject: 'https://cloudprofiler.googleapis.com/$discovery/rest?version=v2'
): Promise<void>;
/** @deprecated Please load APIs with discovery documents. */
function load(name: 'cloudprofiler', version: 'v2'): Promise<void>;
/** @deprecated Please load APIs with discovery documents. */
function load(
name: 'cloudprofiler',
version: 'v2',
callback: () => any
): void;
namespace cloudprofiler {
interface CreateProfileRequest {
/** Deployment details. */
deployment?:
Deployment;
/** One or more profile types that the agent is capable of providing. */
profileType?:
string[];
}
interface Deployment {
/**
* Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must
* be <= 512 bytes, the total size of all label names and values must be <= 1024 bytes. Label named "language" can be used to record the programming language of the profiled
* deployment. The standard choices for the value include "java", "go", "python", "ruby", "nodejs", "php", "dotnet". For deployments running on Google Cloud Platform, "zone" or
* "region" label should be present describing the deployment location. An example of a zone is "us-central1-a", an example of a region is "us-central1" or "us-central".
*/
labels?:
{ [P in string]: string };
/** Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`. */
projectId?:
string;
/**
* Target is the service name used to group related deployments: * Service name for App Engine Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct
* Compute Engine profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z0-9]([-a-z0-9_.]{0,253}[a-z0-9])?$`.
*/
target?:
string;
}
interface Profile {
/** Deployment this profile corresponds to. */
deployment?:
Deployment;
/**
* Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the
* effective profiling duration, which is recorded in the profile data, in case the profiling can't be stopped immediately (e.g. in case stopping the profiling is handled
* asynchronously).
*/
duration?:
string;
/**
* Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for
* validation rules and limits.
*/
labels?:
{ [P in string]: string };
/** Output only. Opaque, server-assigned, unique ID for this profile. */
name?:
string;
/** Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto. */
profileBytes?:
string;
/** Type of profile. For offline mode, this must be specified when creating the profile. For online mode it is assigned and returned by the server. */
profileType?:
string;
}
interface ProfilesResource {
/**
* CreateProfile creates a new profile resource in the online mode. The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may
* hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the
* duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status.
* To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named "google.rpc.retryinfo-bin".
*/
create(request: {
/** V1 error format. */
"$.xgafv"?:
string;
/** OAuth access token. */
access_token?:
string;
/** Data format for response. */
alt?:
string;
/** JSONP */
callback?:
string;
/** Selector specifying which fields to include in a partial response. */
fields?:
string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?:
string;
/** OAuth 2.0 token for the current user. */
oauth_token?:
string;
/** Parent project to create the profile in. */
parent:
string;
/** Returns response with indentations and line breaks. */
prettyPrint?:
boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?:
string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?:
string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?:
string;
/** Request body */
resource:
CreateProfileRequest;
}): Request<Profile>;
create(request: {
/** V1 error format. */
"$.xgafv"?:
string;
/** OAuth access token. */
access_token?:
string;
/** Data format for response. */
alt?:
string;
/** JSONP */
callback?:
string;
/** Selector specifying which fields to include in a partial response. */
fields?:
string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?:
string;
/** OAuth 2.0 token for the current user. */
oauth_token?:
string;
/** Parent project to create the profile in. */
parent:
string;
/** Returns response with indentations and line breaks. */
prettyPrint?:
boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?:
string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?:
string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?:
string;
},
body: CreateProfileRequest): Request<Profile>;
/** CreateOfflineProfile creates a new profile resource in the offline mode. The client provides the profile to create along with the profile bytes, the server records it. */
createOffline(request: {
/** V1 error format. */
"$.xgafv"?:
string;
/** OAuth access token. */
access_token?:
string;
/** Data format for response. */
alt?:
string;
/** JSONP */
callback?:
string;
/** Selector specifying which fields to include in a partial response. */
fields?:
string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?:
string;
/** OAuth 2.0 token for the current user. */
oauth_token?:
string;
/** Parent project to create the profile in. */
parent:
string;
/** Returns response with indentations and line breaks. */
prettyPrint?:
boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?:
string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?:
string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?:
string;
/** Request body */
resource:
Profile;
}): Request<Profile>;
createOffline(request: {
/** V1 error format. */
"$.xgafv"?:
string;
/** OAuth access token. */
access_token?:
string;
/** Data format for response. */
alt?:
string;
/** JSONP */
callback?:
string;
/** Selector specifying which fields to include in a partial response. */
fields?:
string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?:
string;
/** OAuth 2.0 token for the current user. */
oauth_token?:
string;
/** Parent project to create the profile in. */
parent:
string;
/** Returns response with indentations and line breaks. */
prettyPrint?:
boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?:
string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?:
string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?:
string;
},
body: Profile): Request<Profile>;
/**
* UpdateProfile updates the profile bytes and labels on the profile resource created in the online mode. Updating the bytes for profiles created in the offline mode is currently not
* supported: the profile content must be provided at the time of the profile creation.
*/
patch(request: {
/** V1 error format. */
"$.xgafv"?:
string;
/** OAuth access token. */
access_token?:
string;
/** Data format for response. */
alt?:
string;
/** JSONP */
callback?:
string;
/** Selector specifying which fields to include in a partial response. */
fields?:
string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?:
string;
/** Output only. Opaque, server-assigned, unique ID for this profile. */
name:
string;
/** OAuth 2.0 token for the current user. */
oauth_token?:
string;
/** Returns response with indentations and line breaks. */
prettyPrint?:
boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?:
string;
/**
* Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in
* the mask. When no mask is provided, all fields are overwritten.
*/
updateMask?:
string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?:
string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?:
string;
/** Request body */
resource:
Profile;
}): Request<Profile>;
patch(request: {
/** V1 error format. */
"$.xgafv"?:
string;
/** OAuth access token. */
access_token?:
string;
/** Data format for response. */
alt?:
string;
/** JSONP */
callback?:
string;
/** Selector specifying which fields to include in a partial response. */
fields?:
string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?:
string;
/** Output only. Opaque, server-assigned, unique ID for this profile. */
name:
string;
/** OAuth 2.0 token for the current user. */
oauth_token?:
string;
/** Returns response with indentations and line breaks. */
prettyPrint?:
boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?:
string;
/**
* Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in
* the mask. When no mask is provided, all fields are overwritten.
*/
updateMask?:
string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?:
string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?:
string;
},
body: Profile): Request<Profile>;
}
interface ProjectsResource {
profiles:
ProfilesResource;
}
namespace cloudprofiler {
interface CreateProfileRequest {
/** Deployment details. */
deployment?: Deployment;
/** One or more profile types that the agent is capable of providing. */
profileType?: string[];
}
interface Deployment {
/** Labels identify the deployment within the user universe and same target. Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. Value for an individual label must be <= 512 bytes, the total size of all label names and values must be <= 1024 bytes. Label named "language" can be used to record the programming language of the profiled deployment. The standard choices for the value include "java", "go", "python", "ruby", "nodejs", "php", "dotnet". For deployments running on Google Cloud Platform, "zone" or "region" label should be present describing the deployment location. An example of a zone is "us-central1-a", an example of a region is "us-central1" or "us-central". */
labels?: {[P in string]: string};
/** Project ID is the ID of a cloud project. Validation regex: `^a-z{4,61}[a-z0-9]$`. */
projectId?: string;
/** Target is the service name used to group related deployments: * Service name for App Engine Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct Compute Engine profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z0-9]([-a-z0-9_.]{0,253}[a-z0-9])?$`. */
target?: string;
}
interface Profile {
/** Deployment this profile corresponds to. */
deployment?: Deployment;
/** Duration of the profiling session. Input (for the offline mode) or output (for the online mode). The field represents requested profiling duration. It may slightly differ from the effective profiling duration, which is recorded in the profile data, in case the profiling can't be stopped immediately (e.g. in case stopping the profiling is handled asynchronously). */
duration?: string;
/** Input only. Labels associated to this specific profile. These labels will get merged with the deployment labels for the final data set. See documentation on deployment labels for validation rules and limits. */
labels?: {[P in string]: string};
/** Output only. Opaque, server-assigned, unique ID for this profile. */
name?: string;
/** Input only. Profile bytes, as a gzip compressed serialized proto, the format is https://github.com/google/pprof/blob/master/proto/profile.proto. */
profileBytes?: string;
/** Type of profile. For offline mode, this must be specified when creating the profile. For online mode it is assigned and returned by the server. */
profileType?: string;
}
interface ProfilesResource {
/** CreateProfile creates a new profile resource in the online mode. The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named "google.rpc.retryinfo-bin". */
create(request: {
/** V1 error format. */
'$.xgafv'?: string;
/** OAuth access token. */
access_token?: string;
/** Data format for response. */
alt?: string;
/** JSONP */
callback?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Parent project to create the profile in. */
parent: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?: string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?: string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?: string;
/** Request body */
resource: CreateProfileRequest;
}): Request<Profile>;
create(
request: {
/** V1 error format. */
'$.xgafv'?: string;
/** OAuth access token. */
access_token?: string;
/** Data format for response. */
alt?: string;
/** JSONP */
callback?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Parent project to create the profile in. */
parent: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?: string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?: string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?: string;
},
body: CreateProfileRequest
): Request<Profile>;
/** CreateOfflineProfile creates a new profile resource in the offline mode. The client provides the profile to create along with the profile bytes, the server records it. */
createOffline(request: {
/** V1 error format. */
'$.xgafv'?: string;
/** OAuth access token. */
access_token?: string;
/** Data format for response. */
alt?: string;
/** JSONP */
callback?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Parent project to create the profile in. */
parent: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?: string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?: string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?: string;
/** Request body */
resource: Profile;
}): Request<Profile>;
createOffline(
request: {
/** V1 error format. */
'$.xgafv'?: string;
/** OAuth access token. */
access_token?: string;
/** Data format for response. */
alt?: string;
/** JSONP */
callback?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Parent project to create the profile in. */
parent: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?: string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?: string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?: string;
},
body: Profile
): Request<Profile>;
/** UpdateProfile updates the profile bytes and labels on the profile resource created in the online mode. Updating the bytes for profiles created in the offline mode is currently not supported: the profile content must be provided at the time of the profile creation. */
patch(request: {
/** V1 error format. */
'$.xgafv'?: string;
/** OAuth access token. */
access_token?: string;
/** Data format for response. */
alt?: string;
/** JSONP */
callback?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?: string;
/** Output only. Opaque, server-assigned, unique ID for this profile. */
name: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?: string;
/** Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in the mask. When no mask is provided, all fields are overwritten. */
updateMask?: string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?: string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?: string;
/** Request body */
resource: Profile;
}): Request<Profile>;
patch(
request: {
/** V1 error format. */
'$.xgafv'?: string;
/** OAuth access token. */
access_token?: string;
/** Data format for response. */
alt?: string;
/** JSONP */
callback?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
key?: string;
/** Output only. Opaque, server-assigned, unique ID for this profile. */
name: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
quotaUser?: string;
/** Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in the mask. When no mask is provided, all fields are overwritten. */
updateMask?: string;
/** Upload protocol for media (e.g. "raw", "multipart"). */
upload_protocol?: string;
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
uploadType?: string;
},
body: Profile
): Request<Profile>;
}
interface ProjectsResource {
profiles: ProfilesResource;
}
const projects: ProjectsResource;
}
const projects: ProjectsResource;
}
}

12

package.json
{
"name": "@maxim_mazurok/gapi.client.cloudprofiler-v2",
"version": "0.0.20231106",
"version": "0.0.20231127",
"description": "TypeScript typings for Cloud Profiler API v2",
"repository": {
"type": "git",
"url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
},
"license": "MIT",
"author": {
"name": "Maxim Mazurok",
"email": "maxim@mazurok.com",
"name": "Maxim Mazurok",
"url": "https://maxim.mazurok.com"
},
"repository": {
"type": "git",
"url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
},
"types": "index.d.ts",

@@ -16,0 +16,0 @@ "dependencies": {

37

readme.md

@@ -28,6 +28,9 @@ # TypeScript typings for Cloud Profiler API v2

```typescript
gapi.client.load('https://cloudprofiler.googleapis.com/$discovery/rest?version=v2', () => {
// now we can use:
// gapi.client.cloudprofiler
});
gapi.client.load(
'https://cloudprofiler.googleapis.com/$discovery/rest?version=v2',
() => {
// now we can use:
// gapi.client.cloudprofiler
}
);
```

@@ -49,23 +52,24 @@

scope = [
// See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
'https://www.googleapis.com/auth/cloud-platform',
// See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
'https://www.googleapis.com/auth/cloud-platform',
// View and write monitoring data for all of your Google and third-party Cloud and API projects
'https://www.googleapis.com/auth/monitoring',
// View and write monitoring data for all of your Google and third-party Cloud and API projects
'https://www.googleapis.com/auth/monitoring',
// Publish metric data to your Google Cloud projects
'https://www.googleapis.com/auth/monitoring.write',
],
immediate = true;
// Publish metric data to your Google Cloud projects
'https://www.googleapis.com/auth/monitoring.write',
],
immediate = true;
// ...
gapi.auth.authorize(
{ client_id: client_id, scope: scope, immediate: immediate },
{client_id: client_id, scope: scope, immediate: immediate},
authResult => {
if (authResult && !authResult.error) {
/* handle successful authorization */
/* handle successful authorization */
} else {
/* handle authorization error */
/* handle authorization error */
}
});
}
);
```

@@ -76,2 +80,3 @@

```typescript
```
tests.ts
tsconfig.json
tslint.json
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc