Class ImportCertificateRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ImportCertificateRequest.Builder,ImportCertificateRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal InstantAn optional date that specifies when the certificate becomes active.builder()final Stringfinal StringAn optional list of certificates that make up the chain for the certificate that's being imported.final StringA short description that helps identify the certificate.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final InstantAn optional date that specifies when the certificate becomes inactive.final Stringstatic Class<? extends ImportCertificateRequest.Builder> tags()Key-value pairs that can be used to group and search for certificates.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final CertificateUsageTypeusage()Specifies how this certificate is used.final StringSpecifies how this certificate is used.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
usage
Specifies how this certificate is used. It can be used in the following ways:
-
SIGNING: For signing AS2 messages -
ENCRYPTION: For encrypting AS2 messages -
TLS: For securing AS2 communications sent over HTTPS
If the service returns an enum value that is not available in the current SDK version,
usagewill returnCertificateUsageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromusageAsString().- Returns:
- Specifies how this certificate is used. It can be used in the following ways:
-
SIGNING: For signing AS2 messages -
ENCRYPTION: For encrypting AS2 messages -
TLS: For securing AS2 communications sent over HTTPS
-
- See Also:
-
-
usageAsString
Specifies how this certificate is used. It can be used in the following ways:
-
SIGNING: For signing AS2 messages -
ENCRYPTION: For encrypting AS2 messages -
TLS: For securing AS2 communications sent over HTTPS
If the service returns an enum value that is not available in the current SDK version,
usagewill returnCertificateUsageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromusageAsString().- Returns:
- Specifies how this certificate is used. It can be used in the following ways:
-
SIGNING: For signing AS2 messages -
ENCRYPTION: For encrypting AS2 messages -
TLS: For securing AS2 communications sent over HTTPS
-
- See Also:
-
-
certificate
-
For the CLI, provide a file path for a certificate in URI format. For example,
--certificate file://encryption-cert.pem. Alternatively, you can provide the raw content. -
For the SDK, specify the raw content of a certificate file. For example,
--certificate "`cat encryption-cert.pem`".
You can provide both the certificate and its chain in this parameter, without needing to use the
CertificateChainparameter. If you use this parameter for both the certificate and its chain, do not use theCertificateChainparameter.- Returns:
For the CLI, provide a file path for a certificate in URI format. For example,
--certificate file://encryption-cert.pem. Alternatively, you can provide the raw content.For the SDK, specify the raw content of a certificate file. For example,
--certificate "`cat encryption-cert.pem`".You can provide both the certificate and its chain in this parameter, without needing to use the
CertificateChainparameter. If you use this parameter for both the certificate and its chain, do not use theCertificateChainparameter.
-
-
certificateChain
An optional list of certificates that make up the chain for the certificate that's being imported.
- Returns:
- An optional list of certificates that make up the chain for the certificate that's being imported.
-
privateKey
-
For the CLI, provide a file path for a private key in URI format. For example,
--private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file. -
For the SDK, specify the raw content of a private key file. For example,
--private-key "`cat encryption-key.pem`"
- Returns:
For the CLI, provide a file path for a private key in URI format. For example,
--private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file.For the SDK, specify the raw content of a private key file. For example,
--private-key "`cat encryption-key.pem`"
-
-
activeDate
An optional date that specifies when the certificate becomes active. If you do not specify a value,
ActiveDatetakes the same value asNotBeforeDate, which is specified by the CA.- Returns:
- An optional date that specifies when the certificate becomes active. If you do not specify a value,
ActiveDatetakes the same value asNotBeforeDate, which is specified by the CA.
-
inactiveDate
An optional date that specifies when the certificate becomes inactive. If you do not specify a value,
InactiveDatetakes the same value asNotAfterDate, which is specified by the CA.- Returns:
- An optional date that specifies when the certificate becomes inactive. If you do not specify a value,
InactiveDatetakes the same value asNotAfterDate, which is specified by the CA.
-
description
A short description that helps identify the certificate.
- Returns:
- A short description that helps identify the certificate.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
Key-value pairs that can be used to group and search for certificates.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- Key-value pairs that can be used to group and search for certificates.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ImportCertificateRequest.Builder,ImportCertificateRequest> - Specified by:
toBuilderin classTransferRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-