Class SoftwareArtifactsClient

Index

Constructors

Methods

getSoftwareArtifact getSoftwareArtifactVersion listSoftwareArtifacts listSoftwareArtifactsIter listSoftwareArtifactVersions listSoftwareArtifactVersionsIter resolveSoftwareArtifactVersion updateSoftwareArtifact

Constructors

constructor

new SoftwareArtifactsClient(options: ClientOptions): SoftwareArtifactsClient
Parameters
- options: ClientOptions
Returns SoftwareArtifactsClient
- Defined in client.ts:60

Methods

getSoftwareArtifact

getSoftwareArtifact(
req: GetSoftwareArtifactRequest,
options?: CallOptions,
): Promise<SoftwareArtifact>
Gets a software artifact.
Parameters
- req: GetSoftwareArtifactRequest
- Optionaloptions: CallOptions
Returns Promise<SoftwareArtifact>
- Defined in client.ts:76

getSoftwareArtifactVersion

getSoftwareArtifactVersion(
req: GetSoftwareArtifactVersionRequest,
options?: CallOptions,
): Promise<SoftwareArtifactVersion>
Gets a software artifact version.
Parameters
- req: GetSoftwareArtifactVersionRequest
- Optionaloptions: CallOptions
Returns Promise<SoftwareArtifactVersion>
- Defined in client.ts:105

listSoftwareArtifacts

listSoftwareArtifacts(
req: ListSoftwareArtifactsRequest,
options?: CallOptions,
): Promise<ListSoftwareArtifactsResponse>
Lists software artifacts in a schema.
Parameters
- req: ListSoftwareArtifactsRequest
- Optionaloptions: CallOptions
Returns Promise<ListSoftwareArtifactsResponse>
- Defined in client.ts:192

listSoftwareArtifactsIter

listSoftwareArtifactsIter(
req: ListSoftwareArtifactsRequest,
options?: CallOptions,
): AsyncGenerator<SoftwareArtifact>
Parameters
- req: ListSoftwareArtifactsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<SoftwareArtifact>
- Defined in client.ts:235

listSoftwareArtifactVersions

listSoftwareArtifactVersions(
req: ListSoftwareArtifactVersionsRequest,
options?: CallOptions,
): Promise<ListSoftwareArtifactVersionsResponse>
Lists the versions of a software artifact.
Parameters
- req: ListSoftwareArtifactVersionsRequest
- Optionaloptions: CallOptions
Returns Promise<ListSoftwareArtifactVersionsResponse>
- Defined in client.ts:134

listSoftwareArtifactVersionsIter

listSoftwareArtifactVersionsIter(
req: ListSoftwareArtifactVersionsRequest,
options?: CallOptions,
): AsyncGenerator<SoftwareArtifactVersion>
Parameters
- req: ListSoftwareArtifactVersionsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<SoftwareArtifactVersion>
- Defined in client.ts:174

resolveSoftwareArtifactVersion

resolveSoftwareArtifactVersion(
req: ResolveSoftwareArtifactVersionRequest,
options?: CallOptions,
): Promise<ResolveSoftwareArtifactVersionResponse>
Resolves a software artifact version from its tag alias.
Parameters
- req: ResolveSoftwareArtifactVersionRequest
- Optionaloptions: CallOptions
Returns Promise<ResolveSoftwareArtifactVersionResponse>
- Defined in client.ts:253

updateSoftwareArtifact

updateSoftwareArtifact(
req: UpdateSoftwareArtifactRequest,
options?: CallOptions,
): Promise<SoftwareArtifact>
Updates a software artifact. The name is immutable; only the owner may be changed. The destination owner must exist in the account. The caller needs MANAGE_ACCESS_CONTROL on the artifact. The response contains its name and the requested owner; audit fields are omitted.
Parameters
- req: UpdateSoftwareArtifactRequest
- Optionaloptions: CallOptions
Returns Promise<SoftwareArtifact>
- Defined in client.ts:293