Class GetComponentVersionArtifactRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.greengrassv2.model.GreengrassV2Request
software.amazon.awssdk.services.greengrassv2.model.GetComponentVersionArtifactRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetComponentVersionArtifactRequest.Builder,GetComponentVersionArtifactRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetComponentVersionArtifactRequest extends GreengrassV2Request implements ToCopyableBuilder<GetComponentVersionArtifactRequest.Builder,GetComponentVersionArtifactRequest>

  • Method Details

    • arn

      public final String arn()

      The ARN of the component version. Specify the ARN of a public or a Lambda component version.

      Returns:
      The ARN of the component version. Specify the ARN of a public or a Lambda component version.

    • artifactName

      public final String artifactName()

      The name of the artifact.

      You can use the GetComponent operation to download the component recipe, which includes the URI of the artifact. The artifact name is the section of the URI after the scheme. For example, in the artifact URI greengrass:SomeArtifact.zip, the artifact name is SomeArtifact.zip.

      Returns:
      The name of the artifact.

      You can use the GetComponent operation to download the component recipe, which includes the URI of the artifact. The artifact name is the section of the URI after the scheme. For example, in the artifact URI greengrass:SomeArtifact.zip, the artifact name is SomeArtifact.zip.

    • s3EndpointType

      public final S3EndpointType s3EndpointType()

      Specifies the endpoint to use when getting Amazon S3 pre-signed URLs.

      All Amazon Web Services Regions except US East (N. Virginia) use REGIONAL in all cases. In the US East (N. Virginia) Region the default is GLOBAL, but you can change it to REGIONAL with this parameter.

      If the service returns an enum value that is not available in the current SDK version, s3EndpointType will return S3EndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3EndpointTypeAsString().

      Returns:
      Specifies the endpoint to use when getting Amazon S3 pre-signed URLs.

      All Amazon Web Services Regions except US East (N. Virginia) use REGIONAL in all cases. In the US East (N. Virginia) Region the default is GLOBAL, but you can change it to REGIONAL with this parameter.

      See Also:

    • s3EndpointTypeAsString

      public final String s3EndpointTypeAsString()

      Specifies the endpoint to use when getting Amazon S3 pre-signed URLs.

      All Amazon Web Services Regions except US East (N. Virginia) use REGIONAL in all cases. In the US East (N. Virginia) Region the default is GLOBAL, but you can change it to REGIONAL with this parameter.

      If the service returns an enum value that is not available in the current SDK version, s3EndpointType will return S3EndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3EndpointTypeAsString().

      Returns:
      Specifies the endpoint to use when getting Amazon S3 pre-signed URLs.

      All Amazon Web Services Regions except US East (N. Virginia) use REGIONAL in all cases. In the US East (N. Virginia) Region the default is GLOBAL, but you can change it to REGIONAL with this parameter.

      See Also:

    • iotEndpointType

      public final IotEndpointType iotEndpointType()

      Determines if the Amazon S3 URL returned is a FIPS pre-signed URL endpoint. Specify fips if you want the returned Amazon S3 pre-signed URL to point to an Amazon S3 FIPS endpoint. If you don't specify a value, the default is standard.

      If the service returns an enum value that is not available in the current SDK version, iotEndpointType will return IotEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from iotEndpointTypeAsString().

      Returns:
      Determines if the Amazon S3 URL returned is a FIPS pre-signed URL endpoint. Specify fips if you want the returned Amazon S3 pre-signed URL to point to an Amazon S3 FIPS endpoint. If you don't specify a value, the default is standard.
      See Also:

    • iotEndpointTypeAsString

      public final String iotEndpointTypeAsString()

      Determines if the Amazon S3 URL returned is a FIPS pre-signed URL endpoint. Specify fips if you want the returned Amazon S3 pre-signed URL to point to an Amazon S3 FIPS endpoint. If you don't specify a value, the default is standard.

      If the service returns an enum value that is not available in the current SDK version, iotEndpointType will return IotEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from iotEndpointTypeAsString().

      Returns:
      Determines if the Amazon S3 URL returned is a FIPS pre-signed URL endpoint. Specify fips if you want the returned Amazon S3 pre-signed URL to point to an Amazon S3 FIPS endpoint. If you don't specify a value, the default is standard.
      See Also:

    • toBuilder

      public GetComponentVersionArtifactRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetComponentVersionArtifactRequest.Builder,GetComponentVersionArtifactRequest>
      Specified by:
      toBuilder in class GreengrassV2Request
      Returns:
      a builder for type T

    • builder

      public static GetComponentVersionArtifactRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetComponentVersionArtifactRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.