CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold ( https://skaffold.dev ). v1
Package
@google-cloud/deployConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of CloudDeployClient.
opts
ClientOptions
gaxInstance
typeof gax | typeof gax.fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new CloudDeployClient({fallback: 'rest'}, gax); ```
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth
:
gax
.
GoogleAuth
;
cloudDeployStub
cloudDeployStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
descriptors
descriptors
:
Descriptors
;
iamClient
iamClient
:
IamClient
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
operationsClient
operationsClient
:
gax
.
OperationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
abandonRelease(request, options)
abandonRelease
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IAbandonReleaseRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IAbandonReleaseResponse
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IAbandonReleaseRequest
|
undefined
,
{}
|
undefined
]>;
Abandons a Release in the Delivery Pipeline.
request
protos. google.cloud.deploy.v1.IAbandonReleaseRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IAbandonReleaseResponse
,
protos. google.cloud.deploy.v1.IAbandonReleaseRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* 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.
*/
/**
* Required. Name of the Release. Format is
* projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/
* releases/{release}.
*/
// const name = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callAbandonRelease
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
deployClient
.
abandonRelease
(
request
);
console
.
log
(
response
);
}
callAbandonRelease
();
abandonRelease(request, options, callback)
abandonRelease
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IAbandonReleaseRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IAbandonReleaseResponse
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IAbandonReleaseRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IAbandonReleaseRequest
options
CallOptions
callback
Callback
<protos. google.cloud.deploy.v1.IAbandonReleaseResponse
, protos. google.cloud.deploy.v1.IAbandonReleaseRequest
| null | undefined, {} | null | undefined>
void
abandonRelease(request, callback)
abandonRelease
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IAbandonReleaseRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IAbandonReleaseResponse
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IAbandonReleaseRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IAbandonReleaseRequest
callback
Callback
<protos. google.cloud.deploy.v1.IAbandonReleaseResponse
, protos. google.cloud.deploy.v1.IAbandonReleaseRequest
| null | undefined, {} | null | undefined>
void
approveRollout(request, options)
approveRollout
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IApproveRolloutRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IApproveRolloutResponse
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IApproveRolloutRequest
|
undefined
,
{}
|
undefined
]>;
Approves a Rollout.
request
protos. google.cloud.deploy.v1.IApproveRolloutRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IApproveRolloutResponse
,
protos. google.cloud.deploy.v1.IApproveRolloutRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* 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.
*/
/**
* Required. Name of the Rollout. Format is
* projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/
* releases/{release}/rollouts/{rollout}.
*/
// const name = 'abc123'
/**
* Required. True = approve; false = reject
*/
// const approved = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callApproveRollout
()
{
// Construct request
const
request
=
{
name
,
approved
,
};
// Run request
const
response
=
await
deployClient
.
approveRollout
(
request
);
console
.
log
(
response
);
}
callApproveRollout
();
approveRollout(request, options, callback)
approveRollout
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IApproveRolloutRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IApproveRolloutResponse
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IApproveRolloutRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IApproveRolloutRequest
options
CallOptions
callback
Callback
<protos. google.cloud.deploy.v1.IApproveRolloutResponse
, protos. google.cloud.deploy.v1.IApproveRolloutRequest
| null | undefined, {} | null | undefined>
void
approveRollout(request, callback)
approveRollout
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IApproveRolloutRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IApproveRolloutResponse
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IApproveRolloutRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IApproveRolloutRequest
callback
Callback
<protos. google.cloud.deploy.v1.IApproveRolloutResponse
, protos. google.cloud.deploy.v1.IApproveRolloutRequest
| null | undefined, {} | null | undefined>
void
buildPath(project, location, build)
buildPath
(
project
:
string
,
location
:
string
,
build
:
string
)
:
string
;
Return a fully-qualified build resource name string.
project
string
location
string
build
string
string
{string} Resource name string.
cancelOperation(request, options, callback)
cancelOperation
(
request
:
protos
.
google
.
longrunning
.
CancelOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
CancelOperationRequest
,
{}
|
undefined
|
null
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
request
protos. google.longrunning.CancelOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.CancelOperationRequest
, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.longrunning.CancelOperationRequest
, protos. google.protobuf.Empty
, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<protos. google.protobuf.Empty
>
const
client
=
longrunning
.
operationsClient
();
await
client
.
cancelOperation
({
name
:
''
});
checkCreateDeliveryPipelineProgress(name)
checkCreateDeliveryPipelineProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
DeliveryPipeline
,
protos
.
google
.
cloud
.
deploy
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createDeliveryPipeline()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.deploy.v1.DeliveryPipeline
, protos. google.cloud.deploy.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The parent collection in which the `DeliveryPipeline` should be created.
* Format should be projects/{project_id}/locations/{location_name}.
*/
// const parent = 'abc123'
/**
* Required. ID of the `DeliveryPipeline`.
*/
// const deliveryPipelineId = 'abc123'
/**
* Required. The `DeliveryPipeline` to create.
*/
// const deliveryPipeline = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callCreateDeliveryPipeline
()
{
// Construct request
const
request
=
{
parent
,
deliveryPipelineId
,
deliveryPipeline
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
createDeliveryPipeline
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateDeliveryPipeline
();
checkCreateReleaseProgress(name)
checkCreateReleaseProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
Release
,
protos
.
google
.
cloud
.
deploy
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createRelease()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.deploy.v1.Release
, protos. google.cloud.deploy.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The parent collection in which the `Release` should be created.
* Format should be
* projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
*/
// const parent = 'abc123'
/**
* Required. ID of the `Release`.
*/
// const releaseId = 'abc123'
/**
* Required. The `Release` to create.
*/
// const release = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callCreateRelease
()
{
// Construct request
const
request
=
{
parent
,
releaseId
,
release
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
createRelease
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateRelease
();
checkCreateRolloutProgress(name)
checkCreateRolloutProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
Rollout
,
protos
.
google
.
cloud
.
deploy
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createRollout()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.deploy.v1.Rollout
, protos. google.cloud.deploy.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The parent collection in which the `Rollout` should be created.
* Format should be
* projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
*/
// const parent = 'abc123'
/**
* Required. ID of the `Rollout`.
*/
// const rolloutId = 'abc123'
/**
* Required. The `Rollout` to create.
*/
// const rollout = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callCreateRollout
()
{
// Construct request
const
request
=
{
parent
,
rolloutId
,
rollout
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
createRollout
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateRollout
();
checkCreateTargetProgress(name)
checkCreateTargetProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
Target
,
protos
.
google
.
cloud
.
deploy
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createTarget()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.deploy.v1.Target
, protos. google.cloud.deploy.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The parent collection in which the `Target` should be created.
* Format should be
* projects/{project_id}/locations/{location_name}.
*/
// const parent = 'abc123'
/**
* Required. ID of the `Target`.
*/
// const targetId = 'abc123'
/**
* Required. The `Target` to create.
*/
// const target = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callCreateTarget
()
{
// Construct request
const
request
=
{
parent
,
targetId
,
target
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
createTarget
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateTarget
();
checkDeleteDeliveryPipelineProgress(name)
checkDeleteDeliveryPipelineProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
deploy
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteDeliveryPipeline()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.deploy.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The name of the `DeliveryPipeline` to delete. Format should be
* projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
*/
// const name = 'abc123'
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes after the first request.
* 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'
/**
* Optional. If set to true, then deleting an already deleted or non-existing
* `DeliveryPipeline` will succeed.
*/
// const allowMissing = true
/**
* Optional. If set, validate the request and preview the review, but do not actually
* post it.
*/
// const validateOnly = true
/**
* Optional. If set to true, all child resources under this pipeline will also be
* deleted. Otherwise, the request will only work if the pipeline has
* no child resources.
*/
// const force = true
/**
* Optional. This checksum is computed by the server based on the value of other
* fields, and may be sent on update and delete requests to ensure the
* client has an up-to-date value before proceeding.
*/
// const etag = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callDeleteDeliveryPipeline
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
deleteDeliveryPipeline
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteDeliveryPipeline
();
checkDeleteTargetProgress(name)
checkDeleteTargetProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
deploy
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteTarget()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.deploy.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The name of the `Target` to delete. Format should be
* projects/{project_id}/locations/{location_name}/targets/{target_name}.
*/
// const name = 'abc123'
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes after the first request.
* 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'
/**
* Optional. If set to true, then deleting an already deleted or non-existing
* DeliveryPipeline will succeed.
*/
// const allowMissing = true
/**
* Optional. If set, validate the request and preview the review, but do not actually
* post it.
*/
// const validateOnly = true
/**
* Optional. This checksum is computed by the server based on the value of other
* fields, and may be sent on update and delete requests to ensure the
* client has an up-to-date value before proceeding.
*/
// const etag = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callDeleteTarget
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
deleteTarget
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteTarget
();
checkUpdateDeliveryPipelineProgress(name)
checkUpdateDeliveryPipelineProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
DeliveryPipeline
,
protos
.
google
.
cloud
.
deploy
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateDeliveryPipeline()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.deploy.v1.DeliveryPipeline
, protos. google.cloud.deploy.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `DeliveryPipeline` resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The `DeliveryPipeline` to update.
*/
// const deliveryPipeline = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, updating a `DeliveryPipeline` that does not exist will
* result in the creation of a new `DeliveryPipeline`.
*/
// const allowMissing = true
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callUpdateDeliveryPipeline
()
{
// Construct request
const
request
=
{
updateMask
,
deliveryPipeline
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
updateDeliveryPipeline
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateDeliveryPipeline
();
checkUpdateTargetProgress(name)
checkUpdateTargetProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
Target
,
protos
.
google
.
cloud
.
deploy
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateTarget()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.deploy.v1.Target
, protos. google.cloud.deploy.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* Target resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The `Target` to update.
*/
// const target = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, updating a `Target` that does not exist will
* result in the creation of a new `Target`.
*/
// const allowMissing = true
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callUpdateTarget
()
{
// Construct request
const
request
=
{
updateMask
,
target
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
updateTarget
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateTarget
();
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
clusterPath(project, location, cluster)
clusterPath
(
project
:
string
,
location
:
string
,
cluster
:
string
)
:
string
;
Return a fully-qualified cluster resource name string.
project
string
location
string
cluster
string
string
{string} Resource name string.
configPath(project, location)
configPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified config resource name string.
project
string
location
string
string
{string} Resource name string.
createDeliveryPipeline(request, options)
createDeliveryPipeline
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateDeliveryPipelineRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Creates a new DeliveryPipeline in a given project and location.
request
protos. google.cloud.deploy.v1.ICreateDeliveryPipelineRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.deploy.v1.IDeliveryPipeline
, protos. google.cloud.deploy.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The parent collection in which the `DeliveryPipeline` should be created.
* Format should be projects/{project_id}/locations/{location_name}.
*/
// const parent = 'abc123'
/**
* Required. ID of the `DeliveryPipeline`.
*/
// const deliveryPipelineId = 'abc123'
/**
* Required. The `DeliveryPipeline` to create.
*/
// const deliveryPipeline = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callCreateDeliveryPipeline
()
{
// Construct request
const
request
=
{
parent
,
deliveryPipelineId
,
deliveryPipeline
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
createDeliveryPipeline
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateDeliveryPipeline
();
createDeliveryPipeline(request, options, callback)
createDeliveryPipeline
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateDeliveryPipelineRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.ICreateDeliveryPipelineRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.IDeliveryPipeline
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createDeliveryPipeline(request, callback)
createDeliveryPipeline
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateDeliveryPipelineRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.ICreateDeliveryPipelineRequest
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.IDeliveryPipeline
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createRelease(request, options)
createRelease
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateReleaseRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IRelease
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Creates a new Release in a given project and location.
request
protos. google.cloud.deploy.v1.ICreateReleaseRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.deploy.v1.IRelease
, protos. google.cloud.deploy.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The parent collection in which the `Release` should be created.
* Format should be
* projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
*/
// const parent = 'abc123'
/**
* Required. ID of the `Release`.
*/
// const releaseId = 'abc123'
/**
* Required. The `Release` to create.
*/
// const release = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callCreateRelease
()
{
// Construct request
const
request
=
{
parent
,
releaseId
,
release
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
createRelease
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateRelease
();
createRelease(request, options, callback)
createRelease
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateReleaseRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IRelease
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.ICreateReleaseRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.IRelease
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createRelease(request, callback)
createRelease
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateReleaseRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IRelease
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.ICreateReleaseRequest
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.IRelease
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createRollout(request, options)
createRollout
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateRolloutRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IRollout
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Creates a new Rollout in a given project and location.
request
protos. google.cloud.deploy.v1.ICreateRolloutRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.deploy.v1.IRollout
, protos. google.cloud.deploy.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The parent collection in which the `Rollout` should be created.
* Format should be
* projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
*/
// const parent = 'abc123'
/**
* Required. ID of the `Rollout`.
*/
// const rolloutId = 'abc123'
/**
* Required. The `Rollout` to create.
*/
// const rollout = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callCreateRollout
()
{
// Construct request
const
request
=
{
parent
,
rolloutId
,
rollout
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
createRollout
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateRollout
();
createRollout(request, options, callback)
createRollout
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateRolloutRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IRollout
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.ICreateRolloutRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.IRollout
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createRollout(request, callback)
createRollout
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateRolloutRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IRollout
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.ICreateRolloutRequest
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.IRollout
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createTarget(request, options)
createTarget
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateTargetRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Creates a new Target in a given project and location.
request
protos. google.cloud.deploy.v1.ICreateTargetRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.deploy.v1.ITarget
, protos. google.cloud.deploy.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The parent collection in which the `Target` should be created.
* Format should be
* projects/{project_id}/locations/{location_name}.
*/
// const parent = 'abc123'
/**
* Required. ID of the `Target`.
*/
// const targetId = 'abc123'
/**
* Required. The `Target` to create.
*/
// const target = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callCreateTarget
()
{
// Construct request
const
request
=
{
parent
,
targetId
,
target
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
createTarget
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateTarget
();
createTarget(request, options, callback)
createTarget
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateTargetRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.ICreateTargetRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.ITarget
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createTarget(request, callback)
createTarget
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
ICreateTargetRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.ICreateTargetRequest
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.ITarget
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteDeliveryPipeline(request, options)
deleteDeliveryPipeline
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IDeleteDeliveryPipelineRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Deletes a single DeliveryPipeline.
request
protos. google.cloud.deploy.v1.IDeleteDeliveryPipelineRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.deploy.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The name of the `DeliveryPipeline` to delete. Format should be
* projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
*/
// const name = 'abc123'
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes after the first request.
* 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'
/**
* Optional. If set to true, then deleting an already deleted or non-existing
* `DeliveryPipeline` will succeed.
*/
// const allowMissing = true
/**
* Optional. If set, validate the request and preview the review, but do not actually
* post it.
*/
// const validateOnly = true
/**
* Optional. If set to true, all child resources under this pipeline will also be
* deleted. Otherwise, the request will only work if the pipeline has
* no child resources.
*/
// const force = true
/**
* Optional. This checksum is computed by the server based on the value of other
* fields, and may be sent on update and delete requests to ensure the
* client has an up-to-date value before proceeding.
*/
// const etag = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callDeleteDeliveryPipeline
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
deleteDeliveryPipeline
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteDeliveryPipeline
();
deleteDeliveryPipeline(request, options, callback)
deleteDeliveryPipeline
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IDeleteDeliveryPipelineRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IDeleteDeliveryPipelineRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteDeliveryPipeline(request, callback)
deleteDeliveryPipeline
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IDeleteDeliveryPipelineRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IDeleteDeliveryPipelineRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteOperation(request, options, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
request
protos. google.longrunning.DeleteOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.DeleteOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.DeleteOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<protos. google.protobuf.Empty
>
const
client
=
longrunning
.
operationsClient
();
await
client
.
deleteOperation
({
name
:
''
});
deleteTarget(request, options)
deleteTarget
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IDeleteTargetRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Deletes a single Target.
request
protos. google.cloud.deploy.v1.IDeleteTargetRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.deploy.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. The name of the `Target` to delete. Format should be
* projects/{project_id}/locations/{location_name}/targets/{target_name}.
*/
// const name = 'abc123'
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes after the first request.
* 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'
/**
* Optional. If set to true, then deleting an already deleted or non-existing
* DeliveryPipeline will succeed.
*/
// const allowMissing = true
/**
* Optional. If set, validate the request and preview the review, but do not actually
* post it.
*/
// const validateOnly = true
/**
* Optional. This checksum is computed by the server based on the value of other
* fields, and may be sent on update and delete requests to ensure the
* client has an up-to-date value before proceeding.
*/
// const etag = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callDeleteTarget
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
deleteTarget
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteTarget
();
deleteTarget(request, options, callback)
deleteTarget
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IDeleteTargetRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IDeleteTargetRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteTarget(request, callback)
deleteTarget
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IDeleteTargetRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IDeleteTargetRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deliveryPipelinePath(project, location, deliveryPipeline)
deliveryPipelinePath
(
project
:
string
,
location
:
string
,
deliveryPipeline
:
string
)
:
string
;
Return a fully-qualified deliveryPipeline resource name string.
project
string
location
string
deliveryPipeline
string
string
{string} Resource name string.
getConfig(request, options)
getConfig
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IConfig
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetConfigRequest
|
undefined
,
{}
|
undefined
]>;
Gets the configuration for a location.
request
protos. google.cloud.deploy.v1.IGetConfigRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IConfig
,
protos. google.cloud.deploy.v1.IGetConfigRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* 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.
*/
/**
* Required. Name of requested configuration.
*/
// const name = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callGetConfig
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
deployClient
.
getConfig
(
request
);
console
.
log
(
response
);
}
callGetConfig
();
getConfig(request, options, callback)
getConfig
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IConfig
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetConfigRequest
options
CallOptions
callback
Callback
<protos. google.cloud.deploy.v1.IConfig
, protos. google.cloud.deploy.v1.IGetConfigRequest
| null | undefined, {} | null | undefined>
void
getConfig(request, callback)
getConfig
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IConfig
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetConfigRequest
callback
Callback
<protos. google.cloud.deploy.v1.IConfig
, protos. google.cloud.deploy.v1.IGetConfigRequest
| null | undefined, {} | null | undefined>
void
getDeliveryPipeline(request, options)
getDeliveryPipeline
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetDeliveryPipelineRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetDeliveryPipelineRequest
|
undefined
,
{}
|
undefined
]>;
Gets details of a single DeliveryPipeline.
request
protos. google.cloud.deploy.v1.IGetDeliveryPipelineRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IDeliveryPipeline
,
protos. google.cloud.deploy.v1.IGetDeliveryPipelineRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* 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.
*/
/**
* Required. Name of the `DeliveryPipeline`. Format must be
* projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
*/
// const name = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callGetDeliveryPipeline
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
deployClient
.
getDeliveryPipeline
(
request
);
console
.
log
(
response
);
}
callGetDeliveryPipeline
();
getDeliveryPipeline(request, options, callback)
getDeliveryPipeline
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetDeliveryPipelineRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetDeliveryPipelineRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetDeliveryPipelineRequest
options
CallOptions
callback
Callback
<protos. google.cloud.deploy.v1.IDeliveryPipeline
, protos. google.cloud.deploy.v1.IGetDeliveryPipelineRequest
| null | undefined, {} | null | undefined>
void
getDeliveryPipeline(request, callback)
getDeliveryPipeline
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetDeliveryPipelineRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetDeliveryPipelineRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetDeliveryPipelineRequest
callback
Callback
<protos. google.cloud.deploy.v1.IDeliveryPipeline
, protos. google.cloud.deploy.v1.IGetDeliveryPipelineRequest
| null | undefined, {} | null | undefined>
void
getIamPolicy(request, options, callback)
getIamPolicy
(
request
:
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<IamProtos
.
google
.
iam
.
v1
.
Policy
> ;
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
request
IamProtos. google.iam.v1.GetIamPolicyRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.GetIamPolicyRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.GetIamPolicyRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Promise
<IamProtos. google.iam.v1.Policy
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
getJobRun(request, options)
getJobRun
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetJobRunRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IJobRun
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetJobRunRequest
|
undefined
,
{}
|
undefined
]>;
Gets details of a single JobRun.
request
protos. google.cloud.deploy.v1.IGetJobRunRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IJobRun
,
protos. google.cloud.deploy.v1.IGetJobRunRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* 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.
*/
/**
* Required. Name of the `JobRun`. Format must be
* projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}.
*/
// const name = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callGetJobRun
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
deployClient
.
getJobRun
(
request
);
console
.
log
(
response
);
}
callGetJobRun
();
getJobRun(request, options, callback)
getJobRun
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetJobRunRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IJobRun
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetJobRunRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetJobRunRequest
options
CallOptions
callback
Callback
<protos. google.cloud.deploy.v1.IJobRun
, protos. google.cloud.deploy.v1.IGetJobRunRequest
| null | undefined, {} | null | undefined>
void
getJobRun(request, callback)
getJobRun
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetJobRunRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IJobRun
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetJobRunRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetJobRunRequest
callback
Callback
<protos. google.cloud.deploy.v1.IJobRun
, protos. google.cloud.deploy.v1.IGetJobRunRequest
| null | undefined, {} | null | undefined>
void
getLocation(request, options, callback)
getLocation
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
,
options
?:
gax
.
CallOptions
|
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Gets information about a location.
request
LocationProtos. google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<LocationProtos. google.cloud.location.ILocation
, LocationProtos. google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback
<LocationProtos. google.cloud.location.ILocation
, LocationProtos. google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Promise
<LocationProtos. google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
const
[
response
]
=
await
client
.
getLocation
(
request
);
getOperation(request, options, callback)
getOperation
(
request
:
protos
.
google
.
longrunning
.
GetOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise
< [
protos
.
google
.
longrunning
.
Operation
]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
request
protos. google.longrunning.GetOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.longrunning.Operation
, protos. google.longrunning.GetOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.longrunning.Operation
, protos. google.longrunning.GetOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<[protos. google.longrunning.Operation
]>
const
client
=
longrunning
.
operationsClient
();
const
name
=
''
;
const
[
response
]
=
await
client
.
getOperation
({
name
});
// doThingsWith(response)
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
getRelease(request, options)
getRelease
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetReleaseRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IRelease
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetReleaseRequest
|
undefined
,
{}
|
undefined
]>;
Gets details of a single Release.
request
protos. google.cloud.deploy.v1.IGetReleaseRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IRelease
,
protos. google.cloud.deploy.v1.IGetReleaseRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* 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.
*/
/**
* Required. Name of the `Release`. Format must be
* projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.
*/
// const name = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callGetRelease
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
deployClient
.
getRelease
(
request
);
console
.
log
(
response
);
}
callGetRelease
();
getRelease(request, options, callback)
getRelease
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetReleaseRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IRelease
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetReleaseRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetReleaseRequest
options
CallOptions
callback
Callback
<protos. google.cloud.deploy.v1.IRelease
, protos. google.cloud.deploy.v1.IGetReleaseRequest
| null | undefined, {} | null | undefined>
void
getRelease(request, callback)
getRelease
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetReleaseRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IRelease
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetReleaseRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetReleaseRequest
callback
Callback
<protos. google.cloud.deploy.v1.IRelease
, protos. google.cloud.deploy.v1.IGetReleaseRequest
| null | undefined, {} | null | undefined>
void
getRollout(request, options)
getRollout
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetRolloutRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IRollout
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetRolloutRequest
|
undefined
,
{}
|
undefined
]>;
Gets details of a single Rollout.
request
protos. google.cloud.deploy.v1.IGetRolloutRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IRollout
,
protos. google.cloud.deploy.v1.IGetRolloutRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* 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.
*/
/**
* Required. Name of the `Rollout`. Format must be
* projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}.
*/
// const name = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callGetRollout
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
deployClient
.
getRollout
(
request
);
console
.
log
(
response
);
}
callGetRollout
();
getRollout(request, options, callback)
getRollout
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetRolloutRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IRollout
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetRolloutRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetRolloutRequest
options
CallOptions
callback
Callback
<protos. google.cloud.deploy.v1.IRollout
, protos. google.cloud.deploy.v1.IGetRolloutRequest
| null | undefined, {} | null | undefined>
void
getRollout(request, callback)
getRollout
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetRolloutRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IRollout
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetRolloutRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetRolloutRequest
callback
Callback
<protos. google.cloud.deploy.v1.IRollout
, protos. google.cloud.deploy.v1.IGetRolloutRequest
| null | undefined, {} | null | undefined>
void
getTarget(request, options)
getTarget
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetTargetRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetTargetRequest
|
undefined
,
{}
|
undefined
]>;
Gets details of a single Target.
request
protos. google.cloud.deploy.v1.IGetTargetRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.ITarget
,
protos. google.cloud.deploy.v1.IGetTargetRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* 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.
*/
/**
* Required. Name of the `Target`. Format must be
* projects/{project_id}/locations/{location_name}/targets/{target_name}.
*/
// const name = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callGetTarget
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
deployClient
.
getTarget
(
request
);
console
.
log
(
response
);
}
callGetTarget
();
getTarget(request, options, callback)
getTarget
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetTargetRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetTargetRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetTargetRequest
options
CallOptions
callback
Callback
<protos. google.cloud.deploy.v1.ITarget
, protos. google.cloud.deploy.v1.IGetTargetRequest
| null | undefined, {} | null | undefined>
void
getTarget(request, callback)
getTarget
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetTargetRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IGetTargetRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IGetTargetRequest
callback
Callback
<protos. google.cloud.deploy.v1.ITarget
, protos. google.cloud.deploy.v1.IGetTargetRequest
| null | undefined, {} | null | undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
jobRunPath(project, location, deliveryPipeline, release, rollout, jobRun)
jobRunPath
(
project
:
string
,
location
:
string
,
deliveryPipeline
:
string
,
release
:
string
,
rollout
:
string
,
jobRun
:
string
)
:
string
;
Return a fully-qualified jobRun resource name string.
project
string
location
string
deliveryPipeline
string
release
string
rollout
string
jobRun
string
string
{string} Resource name string.
listDeliveryPipelines(request, options)
listDeliveryPipelines
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListDeliveryPipelinesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
[],
protos
.
google
.
cloud
.
deploy
.
v1
.
IListDeliveryPipelinesRequest
|
null
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListDeliveryPipelinesResponse
]>;
Lists DeliveryPipelines in a given project and location.
request
protos. google.cloud.deploy.v1.IListDeliveryPipelinesRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IDeliveryPipeline
[],
protos. google.cloud.deploy.v1.IListDeliveryPipelinesRequest
| null,
protos. google.cloud.deploy.v1.IListDeliveryPipelinesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listDeliveryPipelinesAsync()
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) for more details and examples.
listDeliveryPipelines(request, options, callback)
listDeliveryPipelines
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListDeliveryPipelinesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
deploy
.
v1
.
IListDeliveryPipelinesRequest
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListDeliveryPipelinesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
> )
:
void
;
request
protos. google.cloud.deploy.v1.IListDeliveryPipelinesRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.deploy.v1.IListDeliveryPipelinesRequest
, protos. google.cloud.deploy.v1.IListDeliveryPipelinesResponse
| null | undefined, protos. google.cloud.deploy.v1.IDeliveryPipeline
>
void
listDeliveryPipelines(request, callback)
listDeliveryPipelines
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListDeliveryPipelinesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
deploy
.
v1
.
IListDeliveryPipelinesRequest
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListDeliveryPipelinesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
> )
:
void
;
request
protos. google.cloud.deploy.v1.IListDeliveryPipelinesRequest
callback
PaginationCallback
<protos. google.cloud.deploy.v1.IListDeliveryPipelinesRequest
, protos. google.cloud.deploy.v1.IListDeliveryPipelinesResponse
| null | undefined, protos. google.cloud.deploy.v1.IDeliveryPipeline
>
void
listDeliveryPipelinesAsync(request, options)
listDeliveryPipelinesAsync
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListDeliveryPipelinesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
> ;
Equivalent to listDeliveryPipelines
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.deploy.v1.IListDeliveryPipelinesRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.deploy.v1.IDeliveryPipeline
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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) for more details and examples.
/**
* 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.
*/
/**
* Required. The parent, which owns this collection of pipelines. Format must be
* projects/{project_id}/locations/{location_name}.
*/
// const parent = 'abc123'
/**
* The maximum number of pipelines to return. The service may return
* fewer than this value. If unspecified, at most 50 pipelines will
* be returned. The maximum value is 1000; values above 1000 will be set
* to 1000.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListDeliveryPipelines` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other provided parameters match
* the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* Filter pipelines to be returned. See https://google.aip.dev/160 for more
* details.
*/
// const filter = 'abc123'
/**
* Field to sort by. See https://google.aip.dev/132#ordering for more details.
*/
// const orderBy = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callListDeliveryPipelines
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
deployClient
.
listDeliveryPipelinesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListDeliveryPipelines
();
listDeliveryPipelinesStream(request, options)
listDeliveryPipelinesStream
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListDeliveryPipelinesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.deploy.v1.IListDeliveryPipelinesRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing 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 listDeliveryPipelinesAsync()
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) for more details and examples.
listJobRuns(request, options)
listJobRuns
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListJobRunsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IJobRun
[],
protos
.
google
.
cloud
.
deploy
.
v1
.
IListJobRunsRequest
|
null
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListJobRunsResponse
]>;
Lists JobRuns in a given project and location.
request
protos. google.cloud.deploy.v1.IListJobRunsRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IJobRun
[],
protos. google.cloud.deploy.v1.IListJobRunsRequest
| null,
protos. google.cloud.deploy.v1.IListJobRunsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listJobRunsAsync()
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) for more details and examples.
listJobRuns(request, options, callback)
listJobRuns
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListJobRunsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
deploy
.
v1
.
IListJobRunsRequest
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListJobRunsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IJobRun
> )
:
void
;
request
protos. google.cloud.deploy.v1.IListJobRunsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.deploy.v1.IListJobRunsRequest
, protos. google.cloud.deploy.v1.IListJobRunsResponse
| null | undefined, protos. google.cloud.deploy.v1.IJobRun
>
void
listJobRuns(request, callback)
listJobRuns
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListJobRunsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
deploy
.
v1
.
IListJobRunsRequest
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListJobRunsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IJobRun
> )
:
void
;
request
protos. google.cloud.deploy.v1.IListJobRunsRequest
callback
PaginationCallback
<protos. google.cloud.deploy.v1.IListJobRunsRequest
, protos. google.cloud.deploy.v1.IListJobRunsResponse
| null | undefined, protos. google.cloud.deploy.v1.IJobRun
>
void
listJobRunsAsync(request, options)
listJobRunsAsync
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListJobRunsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
deploy
.
v1
.
IJobRun
> ;
Equivalent to listJobRuns
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.deploy.v1.IListJobRunsRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.deploy.v1.IJobRun
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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) for more details and examples.
/**
* 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.
*/
/**
* Required. The `Rollout` which owns this collection of `JobRun` objects.
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of `JobRun` objects to return. The service may return
* fewer than this value. If unspecified, at most 50 `JobRun` objects will be
* returned. The maximum value is 1000; values above 1000 will be set to 1000.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListJobRuns` call. Provide this
* to retrieve the subsequent page.
* When paginating, all other provided parameters match the call that provided
* the page token.
*/
// const pageToken = 'abc123'
/**
* Optional. Filter results to be returned. See https://google.aip.dev/160 for more
* details.
*/
// const filter = 'abc123'
/**
* Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
*/
// const orderBy = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callListJobRuns
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
deployClient
.
listJobRunsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListJobRuns
();
listJobRunsStream(request, options)
listJobRunsStream
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListJobRunsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.deploy.v1.IListJobRunsRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing 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 listJobRunsAsync()
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) for more details and examples.
listLocationsAsync(request, options)
listLocationsAsync
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IListLocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Lists information about the supported locations for this service. Returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
LocationProtos. google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
AsyncIterable
<LocationProtos. google.cloud.location.ILocation
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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) for more details and examples.
const
iterable
=
client
.
listLocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
// process response
}
listOperationsAsync(request, options)
listOperationsAsync
(
request
:
protos
.
google
.
longrunning
.
ListOperationsRequest
,
options
?:
gax
.
CallOptions
)
:
AsyncIterable<protos
.
google
.
longrunning
.
ListOperationsResponse
> ;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
request
protos. google.longrunning.ListOperationsRequest
The request object that will be sent.
options
gax. CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
AsyncIterable
<protos. google.longrunning.ListOperationsResponse
>
{Object} An iterable Object that conforms to iteration protocols .
const
client
=
longrunning
.
operationsClient
();
for
await
(
const
response
of
client
.
listOperationsAsync
(
request
));
// doThingsWith(response)
listReleases(request, options)
listReleases
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListReleasesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IRelease
[],
protos
.
google
.
cloud
.
deploy
.
v1
.
IListReleasesRequest
|
null
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListReleasesResponse
]>;
Lists Releases in a given project and location.
request
protos. google.cloud.deploy.v1.IListReleasesRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IRelease
[],
protos. google.cloud.deploy.v1.IListReleasesRequest
| null,
protos. google.cloud.deploy.v1.IListReleasesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listReleasesAsync()
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) for more details and examples.
listReleases(request, options, callback)
listReleases
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListReleasesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
deploy
.
v1
.
IListReleasesRequest
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListReleasesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IRelease
> )
:
void
;
request
protos. google.cloud.deploy.v1.IListReleasesRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.deploy.v1.IListReleasesRequest
, protos. google.cloud.deploy.v1.IListReleasesResponse
| null | undefined, protos. google.cloud.deploy.v1.IRelease
>
void
listReleases(request, callback)
listReleases
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListReleasesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
deploy
.
v1
.
IListReleasesRequest
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListReleasesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IRelease
> )
:
void
;
request
protos. google.cloud.deploy.v1.IListReleasesRequest
callback
PaginationCallback
<protos. google.cloud.deploy.v1.IListReleasesRequest
, protos. google.cloud.deploy.v1.IListReleasesResponse
| null | undefined, protos. google.cloud.deploy.v1.IRelease
>
void
listReleasesAsync(request, options)
listReleasesAsync
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListReleasesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
deploy
.
v1
.
IRelease
> ;
Equivalent to listReleases
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.deploy.v1.IListReleasesRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.deploy.v1.IRelease
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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) for more details and examples.
/**
* 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.
*/
/**
* Required. The `DeliveryPipeline` which owns this collection of `Release` objects.
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of `Release` objects to return. The service may return
* fewer than this value. If unspecified, at most 50 `Release` objects will be
* returned. The maximum value is 1000; values above 1000 will be set to 1000.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListReleases` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other provided parameters match
* the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* Optional. Filter releases to be returned. See https://google.aip.dev/160 for more
* details.
*/
// const filter = 'abc123'
/**
* Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
*/
// const orderBy = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callListReleases
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
deployClient
.
listReleasesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListReleases
();
listReleasesStream(request, options)
listReleasesStream
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListReleasesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.deploy.v1.IListReleasesRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing 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 listReleasesAsync()
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) for more details and examples.
listRollouts(request, options)
listRollouts
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListRolloutsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IRollout
[],
protos
.
google
.
cloud
.
deploy
.
v1
.
IListRolloutsRequest
|
null
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListRolloutsResponse
]>;
Lists Rollouts in a given project and location.
request
protos. google.cloud.deploy.v1.IListRolloutsRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IRollout
[],
protos. google.cloud.deploy.v1.IListRolloutsRequest
| null,
protos. google.cloud.deploy.v1.IListRolloutsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listRolloutsAsync()
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) for more details and examples.
listRollouts(request, options, callback)
listRollouts
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListRolloutsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
deploy
.
v1
.
IListRolloutsRequest
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListRolloutsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IRollout
> )
:
void
;
request
protos. google.cloud.deploy.v1.IListRolloutsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.deploy.v1.IListRolloutsRequest
, protos. google.cloud.deploy.v1.IListRolloutsResponse
| null | undefined, protos. google.cloud.deploy.v1.IRollout
>
void
listRollouts(request, callback)
listRollouts
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListRolloutsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
deploy
.
v1
.
IListRolloutsRequest
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListRolloutsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IRollout
> )
:
void
;
request
protos. google.cloud.deploy.v1.IListRolloutsRequest
callback
PaginationCallback
<protos. google.cloud.deploy.v1.IListRolloutsRequest
, protos. google.cloud.deploy.v1.IListRolloutsResponse
| null | undefined, protos. google.cloud.deploy.v1.IRollout
>
void
listRolloutsAsync(request, options)
listRolloutsAsync
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListRolloutsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
deploy
.
v1
.
IRollout
> ;
Equivalent to listRollouts
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.deploy.v1.IListRolloutsRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.deploy.v1.IRollout
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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) for more details and examples.
/**
* 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.
*/
/**
* Required. The `Release` which owns this collection of `Rollout` objects.
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of `Rollout` objects to return. The service may return
* fewer than this value. If unspecified, at most 50 `Rollout` objects will be
* returned. The maximum value is 1000; values above 1000 will be set to 1000.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListRollouts` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other provided parameters match
* the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more
* details.
*/
// const filter = 'abc123'
/**
* Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
*/
// const orderBy = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callListRollouts
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
deployClient
.
listRolloutsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListRollouts
();
listRolloutsStream(request, options)
listRolloutsStream
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListRolloutsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.deploy.v1.IListRolloutsRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing 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 listRolloutsAsync()
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) for more details and examples.
listTargets(request, options)
listTargets
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListTargetsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
[],
protos
.
google
.
cloud
.
deploy
.
v1
.
IListTargetsRequest
|
null
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListTargetsResponse
]>;
Lists Targets in a given project and location.
request
protos. google.cloud.deploy.v1.IListTargetsRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.ITarget
[],
protos. google.cloud.deploy.v1.IListTargetsRequest
| null,
protos. google.cloud.deploy.v1.IListTargetsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listTargetsAsync()
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) for more details and examples.
listTargets(request, options, callback)
listTargets
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListTargetsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
deploy
.
v1
.
IListTargetsRequest
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListTargetsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
> )
:
void
;
request
protos. google.cloud.deploy.v1.IListTargetsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.deploy.v1.IListTargetsRequest
, protos. google.cloud.deploy.v1.IListTargetsResponse
| null | undefined, protos. google.cloud.deploy.v1.ITarget
>
void
listTargets(request, callback)
listTargets
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListTargetsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
deploy
.
v1
.
IListTargetsRequest
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IListTargetsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
> )
:
void
;
request
protos. google.cloud.deploy.v1.IListTargetsRequest
callback
PaginationCallback
<protos. google.cloud.deploy.v1.IListTargetsRequest
, protos. google.cloud.deploy.v1.IListTargetsResponse
| null | undefined, protos. google.cloud.deploy.v1.ITarget
>
void
listTargetsAsync(request, options)
listTargetsAsync
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListTargetsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
> ;
Equivalent to listTargets
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.deploy.v1.IListTargetsRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.deploy.v1.ITarget
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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) for more details and examples.
/**
* 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.
*/
/**
* Required. The parent, which owns this collection of targets. Format must be
* projects/{project_id}/locations/{location_name}.
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of `Target` objects to return. The service may return
* fewer than this value. If unspecified, at most 50 `Target` objects will be
* returned. The maximum value is 1000; values above 1000 will be set to 1000.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListTargets` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other provided parameters match
* the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* Optional. Filter targets to be returned. See https://google.aip.dev/160 for more
* details.
*/
// const filter = 'abc123'
/**
* Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
*/
// const orderBy = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callListTargets
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
deployClient
.
listTargetsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListTargets
();
listTargetsStream(request, options)
listTargetsStream
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IListTargetsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.deploy.v1.IListTargetsRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing 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 listTargetsAsync()
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) for more details and examples.
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
project
string
location
string
string
{string} Resource name string.
matchBuildFromBuildName(buildName)
matchBuildFromBuildName
(
buildName
:
string
)
:
string
|
number
;
Parse the build from Build resource.
buildName
string
A fully-qualified path representing Build resource.
string | number
{string} A string representing the build.
matchClusterFromClusterName(clusterName)
matchClusterFromClusterName
(
clusterName
:
string
)
:
string
|
number
;
Parse the cluster from Cluster resource.
clusterName
string
A fully-qualified path representing Cluster resource.
string | number
{string} A string representing the cluster.
matchDeliveryPipelineFromDeliveryPipelineName(deliveryPipelineName)
matchDeliveryPipelineFromDeliveryPipelineName
(
deliveryPipelineName
:
string
)
:
string
|
number
;
Parse the delivery_pipeline from DeliveryPipeline resource.
deliveryPipelineName
string
A fully-qualified path representing DeliveryPipeline resource.
string | number
{string} A string representing the delivery_pipeline.
matchDeliveryPipelineFromJobRunName(jobRunName)
matchDeliveryPipelineFromJobRunName
(
jobRunName
:
string
)
:
string
|
number
;
Parse the delivery_pipeline from JobRun resource.
jobRunName
string
A fully-qualified path representing JobRun resource.
string | number
{string} A string representing the delivery_pipeline.
matchDeliveryPipelineFromReleaseName(releaseName)
matchDeliveryPipelineFromReleaseName
(
releaseName
:
string
)
:
string
|
number
;
Parse the delivery_pipeline from Release resource.
releaseName
string
A fully-qualified path representing Release resource.
string | number
{string} A string representing the delivery_pipeline.
matchDeliveryPipelineFromRolloutName(rolloutName)
matchDeliveryPipelineFromRolloutName
(
rolloutName
:
string
)
:
string
|
number
;
Parse the delivery_pipeline from Rollout resource.
rolloutName
string
A fully-qualified path representing Rollout resource.
string | number
{string} A string representing the delivery_pipeline.
matchJobRunFromJobRunName(jobRunName)
matchJobRunFromJobRunName
(
jobRunName
:
string
)
:
string
|
number
;
Parse the job_run from JobRun resource.
jobRunName
string
A fully-qualified path representing JobRun resource.
string | number
{string} A string representing the job_run.
matchLocationFromBuildName(buildName)
matchLocationFromBuildName
(
buildName
:
string
)
:
string
|
number
;
Parse the location from Build resource.
buildName
string
A fully-qualified path representing Build resource.
string | number
{string} A string representing the location.
matchLocationFromClusterName(clusterName)
matchLocationFromClusterName
(
clusterName
:
string
)
:
string
|
number
;
Parse the location from Cluster resource.
clusterName
string
A fully-qualified path representing Cluster resource.
string | number
{string} A string representing the location.
matchLocationFromConfigName(configName)
matchLocationFromConfigName
(
configName
:
string
)
:
string
|
number
;
Parse the location from Config resource.
configName
string
A fully-qualified path representing Config resource.
string | number
{string} A string representing the location.
matchLocationFromDeliveryPipelineName(deliveryPipelineName)
matchLocationFromDeliveryPipelineName
(
deliveryPipelineName
:
string
)
:
string
|
number
;
Parse the location from DeliveryPipeline resource.
deliveryPipelineName
string
A fully-qualified path representing DeliveryPipeline resource.
string | number
{string} A string representing the location.
matchLocationFromJobRunName(jobRunName)
matchLocationFromJobRunName
(
jobRunName
:
string
)
:
string
|
number
;
Parse the location from JobRun resource.
jobRunName
string
A fully-qualified path representing JobRun resource.
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the location.
matchLocationFromMembershipName(membershipName)
matchLocationFromMembershipName
(
membershipName
:
string
)
:
string
|
number
;
Parse the location from Membership resource.
membershipName
string
A fully-qualified path representing Membership resource.
string | number
{string} A string representing the location.
matchLocationFromReleaseName(releaseName)
matchLocationFromReleaseName
(
releaseName
:
string
)
:
string
|
number
;
Parse the location from Release resource.
releaseName
string
A fully-qualified path representing Release resource.
string | number
{string} A string representing the location.
matchLocationFromRolloutName(rolloutName)
matchLocationFromRolloutName
(
rolloutName
:
string
)
:
string
|
number
;
Parse the location from Rollout resource.
rolloutName
string
A fully-qualified path representing Rollout resource.
string | number
{string} A string representing the location.
matchLocationFromTargetName(targetName)
matchLocationFromTargetName
(
targetName
:
string
)
:
string
|
number
;
Parse the location from Target resource.
targetName
string
A fully-qualified path representing Target resource.
string | number
{string} A string representing the location.
matchLocationFromWorkerPoolName(workerPoolName)
matchLocationFromWorkerPoolName
(
workerPoolName
:
string
)
:
string
|
number
;
Parse the location from WorkerPool resource.
workerPoolName
string
A fully-qualified path representing WorkerPool resource.
string | number
{string} A string representing the location.
matchMembershipFromMembershipName(membershipName)
matchMembershipFromMembershipName
(
membershipName
:
string
)
:
string
|
number
;
Parse the membership from Membership resource.
membershipName
string
A fully-qualified path representing Membership resource.
string | number
{string} A string representing the membership.
matchProjectFromBuildName(buildName)
matchProjectFromBuildName
(
buildName
:
string
)
:
string
|
number
;
Parse the project from Build resource.
buildName
string
A fully-qualified path representing Build resource.
string | number
{string} A string representing the project.
matchProjectFromClusterName(clusterName)
matchProjectFromClusterName
(
clusterName
:
string
)
:
string
|
number
;
Parse the project from Cluster resource.
clusterName
string
A fully-qualified path representing Cluster resource.
string | number
{string} A string representing the project.
matchProjectFromConfigName(configName)
matchProjectFromConfigName
(
configName
:
string
)
:
string
|
number
;
Parse the project from Config resource.
configName
string
A fully-qualified path representing Config resource.
string | number
{string} A string representing the project.
matchProjectFromDeliveryPipelineName(deliveryPipelineName)
matchProjectFromDeliveryPipelineName
(
deliveryPipelineName
:
string
)
:
string
|
number
;
Parse the project from DeliveryPipeline resource.
deliveryPipelineName
string
A fully-qualified path representing DeliveryPipeline resource.
string | number
{string} A string representing the project.
matchProjectFromJobRunName(jobRunName)
matchProjectFromJobRunName
(
jobRunName
:
string
)
:
string
|
number
;
Parse the project from JobRun resource.
jobRunName
string
A fully-qualified path representing JobRun resource.
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the project.
matchProjectFromMembershipName(membershipName)
matchProjectFromMembershipName
(
membershipName
:
string
)
:
string
|
number
;
Parse the project from Membership resource.
membershipName
string
A fully-qualified path representing Membership resource.
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
projectName
string
A fully-qualified path representing Project resource.
string | number
{string} A string representing the project.
matchProjectFromReleaseName(releaseName)
matchProjectFromReleaseName
(
releaseName
:
string
)
:
string
|
number
;
Parse the project from Release resource.
releaseName
string
A fully-qualified path representing Release resource.
string | number
{string} A string representing the project.
matchProjectFromRolloutName(rolloutName)
matchProjectFromRolloutName
(
rolloutName
:
string
)
:
string
|
number
;
Parse the project from Rollout resource.
rolloutName
string
A fully-qualified path representing Rollout resource.
string | number
{string} A string representing the project.
matchProjectFromTargetName(targetName)
matchProjectFromTargetName
(
targetName
:
string
)
:
string
|
number
;
Parse the project from Target resource.
targetName
string
A fully-qualified path representing Target resource.
string | number
{string} A string representing the project.
matchProjectFromWorkerPoolName(workerPoolName)
matchProjectFromWorkerPoolName
(
workerPoolName
:
string
)
:
string
|
number
;
Parse the project from WorkerPool resource.
workerPoolName
string
A fully-qualified path representing WorkerPool resource.
string | number
{string} A string representing the project.
matchReleaseFromJobRunName(jobRunName)
matchReleaseFromJobRunName
(
jobRunName
:
string
)
:
string
|
number
;
Parse the release from JobRun resource.
jobRunName
string
A fully-qualified path representing JobRun resource.
string | number
{string} A string representing the release.
matchReleaseFromReleaseName(releaseName)
matchReleaseFromReleaseName
(
releaseName
:
string
)
:
string
|
number
;
Parse the release from Release resource.
releaseName
string
A fully-qualified path representing Release resource.
string | number
{string} A string representing the release.
matchReleaseFromRolloutName(rolloutName)
matchReleaseFromRolloutName
(
rolloutName
:
string
)
:
string
|
number
;
Parse the release from Rollout resource.
rolloutName
string
A fully-qualified path representing Rollout resource.
string | number
{string} A string representing the release.
matchRolloutFromJobRunName(jobRunName)
matchRolloutFromJobRunName
(
jobRunName
:
string
)
:
string
|
number
;
Parse the rollout from JobRun resource.
jobRunName
string
A fully-qualified path representing JobRun resource.
string | number
{string} A string representing the rollout.
matchRolloutFromRolloutName(rolloutName)
matchRolloutFromRolloutName
(
rolloutName
:
string
)
:
string
|
number
;
Parse the rollout from Rollout resource.
rolloutName
string
A fully-qualified path representing Rollout resource.
string | number
{string} A string representing the rollout.
matchTargetFromTargetName(targetName)
matchTargetFromTargetName
(
targetName
:
string
)
:
string
|
number
;
Parse the target from Target resource.
targetName
string
A fully-qualified path representing Target resource.
string | number
{string} A string representing the target.
matchWorkerPoolFromWorkerPoolName(workerPoolName)
matchWorkerPoolFromWorkerPoolName
(
workerPoolName
:
string
)
:
string
|
number
;
Parse the worker_pool from WorkerPool resource.
workerPoolName
string
A fully-qualified path representing WorkerPool resource.
string | number
{string} A string representing the worker_pool.
membershipPath(project, location, membership)
membershipPath
(
project
:
string
,
location
:
string
,
membership
:
string
)
:
string
;
Return a fully-qualified membership resource name string.
project
string
location
string
membership
string
string
{string} Resource name string.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
project
string
string
{string} Resource name string.
releasePath(project, location, deliveryPipeline, release)
releasePath
(
project
:
string
,
location
:
string
,
deliveryPipeline
:
string
,
release
:
string
)
:
string
;
Return a fully-qualified release resource name string.
project
string
location
string
deliveryPipeline
string
release
string
string
{string} Resource name string.
retryJob(request, options)
retryJob
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IRetryJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
deploy
.
v1
.
IRetryJobResponse
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IRetryJobRequest
|
undefined
,
{}
|
undefined
]>;
Retries the specified Job in a Rollout.
request
protos. google.cloud.deploy.v1.IRetryJobRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.deploy.v1.IRetryJobResponse
,
protos. google.cloud.deploy.v1.IRetryJobRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* 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.
*/
/**
* Required. Name of the Rollout. Format is
* projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/
* releases/{release}/rollouts/{rollout}.
*/
// const rollout = 'abc123'
/**
* Required. The phase ID the Job to retry belongs to.
*/
// const phaseId = 'abc123'
/**
* Required. The job ID for the Job to retry.
*/
// const jobId = 'abc123'
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callRetryJob
()
{
// Construct request
const
request
=
{
rollout
,
phaseId
,
jobId
,
};
// Run request
const
response
=
await
deployClient
.
retryJob
(
request
);
console
.
log
(
response
);
}
callRetryJob
();
retryJob(request, options, callback)
retryJob
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IRetryJobRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IRetryJobResponse
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IRetryJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IRetryJobRequest
options
CallOptions
callback
Callback
<protos. google.cloud.deploy.v1.IRetryJobResponse
, protos. google.cloud.deploy.v1.IRetryJobRequest
| null | undefined, {} | null | undefined>
void
retryJob(request, callback)
retryJob
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IRetryJobRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
deploy
.
v1
.
IRetryJobResponse
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IRetryJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IRetryJobRequest
callback
Callback
<protos. google.cloud.deploy.v1.IRetryJobResponse
, protos. google.cloud.deploy.v1.IRetryJobRequest
| null | undefined, {} | null | undefined>
void
rolloutPath(project, location, deliveryPipeline, release, rollout)
rolloutPath
(
project
:
string
,
location
:
string
,
deliveryPipeline
:
string
,
release
:
string
,
rollout
:
string
)
:
string
;
Return a fully-qualified rollout resource name string.
project
string
location
string
deliveryPipeline
string
release
string
rollout
string
string
{string} Resource name string.
setIamPolicy(request, options, callback)
setIamPolicy
(
request
:
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<IamProtos
.
google
.
iam
.
v1
.
Policy
> ;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
request
IamProtos. google.iam.v1.SetIamPolicyRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.SetIamPolicyRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<IamProtos. google.iam.v1.Policy
, IamProtos. google.iam.v1.SetIamPolicyRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Promise
<IamProtos. google.iam.v1.Policy
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
targetPath(project, location, target)
targetPath
(
project
:
string
,
location
:
string
,
target
:
string
)
:
string
;
Return a fully-qualified target resource name string.
project
string
location
string
target
string
string
{string} Resource name string.
testIamPermissions(request, options, callback)
testIamPermissions
(
request
:
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
,
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
,
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
> ;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
request
IamProtos. google.iam.v1.TestIamPermissionsRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<IamProtos. google.iam.v1.TestIamPermissionsResponse
, IamProtos. google.iam.v1.TestIamPermissionsRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<IamProtos. google.iam.v1.TestIamPermissionsResponse
, IamProtos. google.iam.v1.TestIamPermissionsRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Promise
<IamProtos. google.iam.v1.TestIamPermissionsResponse
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
updateDeliveryPipeline(request, options)
updateDeliveryPipeline
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IUpdateDeliveryPipelineRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Updates the parameters of a single DeliveryPipeline.
request
protos. google.cloud.deploy.v1.IUpdateDeliveryPipelineRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.deploy.v1.IDeliveryPipeline
, protos. google.cloud.deploy.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `DeliveryPipeline` resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The `DeliveryPipeline` to update.
*/
// const deliveryPipeline = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, updating a `DeliveryPipeline` that does not exist will
* result in the creation of a new `DeliveryPipeline`.
*/
// const allowMissing = true
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callUpdateDeliveryPipeline
()
{
// Construct request
const
request
=
{
updateMask
,
deliveryPipeline
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
updateDeliveryPipeline
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateDeliveryPipeline
();
updateDeliveryPipeline(request, options, callback)
updateDeliveryPipeline
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IUpdateDeliveryPipelineRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IUpdateDeliveryPipelineRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.IDeliveryPipeline
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateDeliveryPipeline(request, callback)
updateDeliveryPipeline
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IUpdateDeliveryPipelineRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
IDeliveryPipeline
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IUpdateDeliveryPipelineRequest
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.IDeliveryPipeline
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateTarget(request, options)
updateTarget
(
request
?:
protos
.
google
.
cloud
.
deploy
.
v1
.
IUpdateTargetRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Updates the parameters of a single Target.
request
protos. google.cloud.deploy.v1.IUpdateTargetRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.deploy.v1.ITarget
, protos. google.cloud.deploy.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* Target resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The `Target` to update.
*/
// const target = {}
/**
* Optional. A 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. The server will guarantee
* that for at least 60 minutes since the first request.
* 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'
/**
* Optional. If set to true, updating a `Target` that does not exist will
* result in the creation of a new `Target`.
*/
// const allowMissing = true
/**
* Optional. If set to true, the request is validated and the user is provided with
* an expected result, but no actual change is made.
*/
// const validateOnly = true
// Imports the Deploy library
const
{
CloudDeployClient
}
=
require
(
' @google-cloud/deploy
'
).
v1
;
// Instantiates a client
const
deployClient
=
new
CloudDeployClient
();
async
function
callUpdateTarget
()
{
// Construct request
const
request
=
{
updateMask
,
target
,
};
// Run request
const
[
operation
]
=
await
deployClient
.
updateTarget
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateTarget
();
updateTarget(request, options, callback)
updateTarget
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IUpdateTargetRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IUpdateTargetRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.ITarget
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateTarget(request, callback)
updateTarget
(
request
:
protos
.
google
.
cloud
.
deploy
.
v1
.
IUpdateTargetRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
deploy
.
v1
.
ITarget
,
protos
.
google
.
cloud
.
deploy
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.deploy.v1.IUpdateTargetRequest
callback
Callback
< LROperation
<protos. google.cloud.deploy.v1.ITarget
, protos. google.cloud.deploy.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
workerPoolPath(project, location, workerPool)
workerPoolPath
(
project
:
string
,
location
:
string
,
workerPool
:
string
)
:
string
;
Return a fully-qualified workerPool resource name string.
project
string
location
string
workerPool
string
string
{string} Resource name string.
