Class CreateLinkRequest

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

  • Method Details

    • labelTemplate

      public final String labelTemplate()

      Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

      You can use a custom label or use the following variables:

      • $AccountName is the name of the account

      • $AccountEmail is the globally unique email address of the account

      • $AccountEmailNoDomain is the email address of the account without the domain name

      In the Amazon Web Services GovCloud (US-East) and Amazon Web Services GovCloud (US-West) Regions, the only supported option is to use custom labels, and the $AccountName, $AccountEmail, and $AccountEmailNoDomain variables all resolve as account-id instead of the specified variable.

      Returns:
      Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

      You can use a custom label or use the following variables:

      • $AccountName is the name of the account

      • $AccountEmail is the globally unique email address of the account

      • $AccountEmailNoDomain is the email address of the account without the domain name

      In the Amazon Web Services GovCloud (US-East) and Amazon Web Services GovCloud (US-West) Regions, the only supported option is to use custom labels, and the $AccountName, $AccountEmail, and $AccountEmailNoDomain variables all resolve as account-id instead of the specified variable.

    • linkConfiguration

      public final LinkConfiguration linkConfiguration()

      Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.

      Returns:
      Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.

    • resourceTypes

      public final List<ResourceType> resourceTypes()

      An array of strings that define which types of data that the source account shares with the monitoring account.

      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 hasResourceTypes() method.

      Returns:
      An array of strings that define which types of data that the source account shares with the monitoring account.

    • hasResourceTypes

      public final boolean hasResourceTypes()
      For responses, this returns true if the service returned a value for the ResourceTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • resourceTypesAsStrings

      public final List<String> resourceTypesAsStrings()

      An array of strings that define which types of data that the source account shares with the monitoring account.

      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 hasResourceTypes() method.

      Returns:
      An array of strings that define which types of data that the source account shares with the monitoring account.

    • sinkIdentifier

      public final String sinkIdentifier()

      The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.

      For more information about sinks, see CreateSink.

      Returns:
      The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.

      For more information about sinks, see CreateSink.

    • 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 the isEmpty() 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

      public final Map<String,String> tags()

      Assigns one or more tags (key-value pairs) to the link.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

      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:
      Assigns one or more tags (key-value pairs) to the link.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

    • toBuilder

      public CreateLinkRequest.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<CreateLinkRequest.Builder,CreateLinkRequest>
      Specified by:
      toBuilder in class OamRequest
      Returns:
      a builder for type T

    • builder

      public static CreateLinkRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateLinkRequest.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.