Class GCMChannelRequest

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.GCMChannelRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GCMChannelRequest.Builder,GCMChannelRequest>
@Generated("software.amazon.awssdk:codegen") public final class GCMChannelRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GCMChannelRequest.Builder,GCMChannelRequest>

Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

See Also:

  • Method Details

    • apiKey

      public final String apiKey()

      The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

      Returns:
      The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

    • defaultAuthenticationMethod

      public final String defaultAuthenticationMethod()

      The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".

      Returns:
      The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".

    • enabled

      public final Boolean enabled()

      Specifies whether to enable the GCM channel for the application.

      Returns:
      Specifies whether to enable the GCM channel for the application.

    • serviceJson

      public final String serviceJson()

      The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see Migrate from legacy FCM APIs to HTTP v1.

      Returns:
      The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see Migrate from legacy FCM APIs to HTTP v1.

    • toBuilder

      public GCMChannelRequest.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<GCMChannelRequest.Builder,GCMChannelRequest>
      Returns:
      a builder for type T

    • builder

      public static GCMChannelRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.