Class: Aws::CodeArtifact::Types::ListPackagesRequest

Inherits:

Struct

• Object
• Struct
• Aws::CodeArtifact::Types::ListPackagesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-codeartifact/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #domain ⇒ String

  The name of the domain that contains the repository that contains the requested packages.

• #domain_owner ⇒ String

  The 12-digit account number of the Amazon Web Services account that owns the domain.

• #format ⇒ String

  The format used to filter requested packages.

• #max_results ⇒ Integer

  The maximum number of results to return per page.

• #namespace ⇒ String

  The namespace prefix used to filter requested packages.

• #next_token ⇒ String

  The token for the next set of results.

• #package_prefix ⇒ String

  A prefix used to filter requested packages.

• #publish ⇒ String

  The value of the ‘Publish` package origin control restriction used to filter requested packages.

• #repository ⇒ String

  The name of the repository that contains the requested packages.

• #upstream ⇒ String

  The value of the ‘Upstream` package origin control restriction used to filter requested packages.

Instance Attribute Details

#domain ⇒ String

The name of the domain that contains the repository that contains the requested packages.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2660

class ListPackagesRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package_prefix,
  :max_results,
  :next_token,
  :publish,
  :upstream)
  SENSITIVE = []
  include Aws::Structure
end

#domain_owner ⇒ String

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2660

class ListPackagesRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package_prefix,
  :max_results,
  :next_token,
  :publish,
  :upstream)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

The format used to filter requested packages. Only packages from the provided format will be returned.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2660

class ListPackagesRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package_prefix,
  :max_results,
  :next_token,
  :publish,
  :upstream)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per page.

Returns:

• (Integer)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2660

class ListPackagesRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package_prefix,
  :max_results,
  :next_token,
  :publish,
  :upstream)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called ‘–namespace` and not `–namespace-prefix`, it has prefix-matching behavior.

Each package format uses namespace as follows:

• The namespace of a Maven package version is its ‘groupId`.

• The namespace of an npm or Swift package version is its ‘scope`.

• The namespace of a generic package is its ‘namespace`.

• Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2660

class ListPackagesRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package_prefix,
  :max_results,
  :next_token,
  :publish,
  :upstream)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2660

class ListPackagesRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package_prefix,
  :max_results,
  :next_token,
  :publish,
  :upstream)
  SENSITIVE = []
  include Aws::Structure
end

#package_prefix ⇒ String

A prefix used to filter requested packages. Only packages with names that start with ‘packagePrefix` are returned.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2660

class ListPackagesRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package_prefix,
  :max_results,
  :next_token,
  :publish,
  :upstream)
  SENSITIVE = []
  include Aws::Structure
end

#publish ⇒ String

The value of the ‘Publish` package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see [PackageOriginRestrictions].

[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2660

class ListPackagesRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package_prefix,
  :max_results,
  :next_token,
  :publish,
  :upstream)
  SENSITIVE = []
  include Aws::Structure
end

#repository ⇒ String

The name of the repository that contains the requested packages.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2660

class ListPackagesRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package_prefix,
  :max_results,
  :next_token,
  :publish,
  :upstream)
  SENSITIVE = []
  include Aws::Structure
end

#upstream ⇒ String

The value of the ‘Upstream` package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see [PackageOriginRestrictions].

[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2660

class ListPackagesRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package_prefix,
  :max_results,
  :next_token,
  :publish,
  :upstream)
  SENSITIVE = []
  include Aws::Structure
end