FetchAndJoinCustomAudienceRequest

public final class FetchAndJoinCustomAudienceRequest
extends Object

java.lang.Object
   ↳ android.adservices.customaudience.FetchAndJoinCustomAudienceRequest

The request object wrapping the required and optional parameters needed to fetch a CustomAudience.

fetchUri is the only required parameter. It represents the URI to fetch a custom audience from. name, activationTime, expirationTime and userBiddingSignals are optional parameters. They represent a partial custom audience which can be used by the caller to inform the choice of the custom audience the user should be added to. Any field set by the caller cannot be overridden by the custom audience fetched from the fetchUri. For more information about each field refer to CustomAudience.

Summary

Nested classes

class FetchAndJoinCustomAudienceRequest.Builder

Builder for FetchAndJoinCustomAudienceRequest objects. 

Public methods

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

Instant getActivationTime()

Reference CustomAudience#getActivationTime() for details.

Instant getExpirationTime()

Reference CustomAudience#getExpirationTime() for details.

Uri getFetchUri()
String getName()

Reference CustomAudience#getName() for details.

AdSelectionSignals getUserBiddingSignals()

Reference CustomAudience#getUserBiddingSignals() for details.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Inherited methods

Public methods

equals

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.
Returns
boolean true only if two FetchAndJoinCustomAudienceRequest objects contain the same information.

getActivationTime

public Instant getActivationTime ()

Reference CustomAudience#getActivationTime() for details.

Returns
Instant the Instant by which joining the custom audience will be delayed. This value may be null.

getExpirationTime

public Instant getExpirationTime ()

Reference CustomAudience#getExpirationTime() for details.

Returns
Instant the Instant by when the membership to the custom audience will expire. This value may be null.

getFetchUri

public Uri getFetchUri ()

Returns
Uri the Uri from which the custom audience is to be fetched. This value cannot be null.

getName

public String getName ()

Reference CustomAudience#getName() for details.

Returns
String the String name of the custom audience to join. This value may be null.

getUserBiddingSignals

public AdSelectionSignals getUserBiddingSignals ()

Reference CustomAudience#getUserBiddingSignals() for details.

Returns
AdSelectionSignals the buyer signals to be consumed by the buyer-provided JavaScript when the custom audience participates in an ad selection. This value may be null.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

Returns
int the hash of the FetchAndJoinCustomAudienceRequest object's data.

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
String a human-readable representation of FetchAndJoinCustomAudienceRequest.