Class CreateServiceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateServiceRequest.Builder,
CreateServiceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of the code repository branch that holds the code that's deployed in Proton.static CreateServiceRequest.Builder
builder()
final String
A description of the Proton service.final boolean
final boolean
equalsBySdkFields
(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 int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
The service name.final String
The Amazon Resource Name (ARN) of the repository connection.final String
The ID of the code repository.static Class
<? extends CreateServiceRequest.Builder> final String
spec()
A link to a spec file that provides inputs as defined in the service template bundle schema file.tags()
An optional list of metadata items that you can associate with the Proton service.final String
The major version of the service template that was used to create the service.final String
The minor version of the service template that was used to create the service.final String
The name of the service template that's used to create the service.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
branchName
The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.
- Returns:
- The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.
-
description
A description of the Proton service.
- Returns:
- A description of the Proton service.
-
name
The service name.
- Returns:
- The service name.
-
repositoryConnectionArn
The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.
- Returns:
- The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.
-
repositoryId
The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.
- Returns:
- The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.
-
spec
A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton User Guide.
- Returns:
- A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton User Guide.
-
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
An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide.
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:
- An optional list of metadata items that you can associate with the Proton service. A tag is a key-value
pair.
For more information, see Proton resources and tagging in the Proton User Guide.
-
templateMajorVersion
The major version of the service template that was used to create the service.
- Returns:
- The major version of the service template that was used to create the service.
-
templateMinorVersion
The minor version of the service template that was used to create the service.
- Returns:
- The minor version of the service template that was used to create the service.
-
templateName
The name of the service template that's used to create the service.
- Returns:
- The name of the service template that's used to create the service.
-
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 interfaceToCopyableBuilder<CreateServiceRequest.Builder,
CreateServiceRequest> - Specified by:
toBuilder
in classProtonRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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
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. -
getValueForField
Description copied from class:SdkRequest
Used 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:
getValueForField
in 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
-