Class DaiAuthenticationKey (0.58.0)

public final class DaiAuthenticationKey extends GeneratedMessage implements DaiAuthenticationKeyOrBuilder

A DaiAuthenticationKey is used to authenticate stream requests to the IMA SDK API.

Protobuf type google.ads.admanager.v1.DaiAuthenticationKey

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

KEY_TYPE_FIELD_NUMBER

public static final int KEY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DaiAuthenticationKey getDefaultInstance()
Returns
Type Description
DaiAuthenticationKey

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DaiAuthenticationKey.Builder newBuilder()
Returns
Type Description
DaiAuthenticationKey.Builder

newBuilder(DaiAuthenticationKey prototype)

public static DaiAuthenticationKey.Builder newBuilder(DaiAuthenticationKey prototype)
Parameter
Name Description
prototype DaiAuthenticationKey
Returns
Type Description
DaiAuthenticationKey.Builder

parseDelimitedFrom(InputStream input)

public static DaiAuthenticationKey parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiAuthenticationKey parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DaiAuthenticationKey parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DaiAuthenticationKey parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DaiAuthenticationKey parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DaiAuthenticationKey parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DaiAuthenticationKey parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiAuthenticationKey parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DaiAuthenticationKey parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiAuthenticationKey parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DaiAuthenticationKey parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DaiAuthenticationKey parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiAuthenticationKey
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DaiAuthenticationKey> parser()
Returns
Type Description
Parser<DaiAuthenticationKey>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DaiAuthenticationKey getDefaultInstanceForType()
Returns
Type Description
DaiAuthenticationKey

getDisplayName()

public String getDisplayName()

Required. The name for this DaiAuthenticationKey.

optional string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The name for this DaiAuthenticationKey.

optional string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getKeyType()

public DaiAuthenticationKeyTypeEnum.DaiAuthenticationKeyType getKeyType()

Optional. The type of this key, which determines how it should be used on stream create requests.

optional .google.ads.admanager.v1.DaiAuthenticationKeyTypeEnum.DaiAuthenticationKeyType key_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DaiAuthenticationKeyTypeEnum.DaiAuthenticationKeyType

The keyType.

getKeyTypeValue()

public int getKeyTypeValue()

Optional. The type of this key, which determines how it should be used on stream create requests.

optional .google.ads.admanager.v1.DaiAuthenticationKeyTypeEnum.DaiAuthenticationKeyType key_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for keyType.

getName()

public String getName()

Identifier. The resource name of the DaiAuthenticationKey. Format: networks/{network_code}/daiAuthenticationKeys/{dai_authentication_key}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the DaiAuthenticationKey. Format: networks/{network_code}/daiAuthenticationKeys/{dai_authentication_key}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<DaiAuthenticationKey> getParserForType()
Returns
Type Description
Parser<DaiAuthenticationKey>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public DaiAuthenticationKeyStatusEnum.DaiAuthenticationKeyStatus getStatus()

Output only. The status of this DaiAuthenticationKey.

DAI authentication keys are created in the ACTIVE state.

Only active keys will be accepted by the IMA SDK API as valid.

optional .google.ads.admanager.v1.DaiAuthenticationKeyStatusEnum.DaiAuthenticationKeyStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DaiAuthenticationKeyStatusEnum.DaiAuthenticationKeyStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of this DaiAuthenticationKey.

DAI authentication keys are created in the ACTIVE state.

Only active keys will be accepted by the IMA SDK API as valid.

optional .google.ads.admanager.v1.DaiAuthenticationKeyStatusEnum.DaiAuthenticationKeyStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

hasDisplayName()

public boolean hasDisplayName()

Required. The name for this DaiAuthenticationKey.

optional string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the displayName field is set.

hasKeyType()

public boolean hasKeyType()

Optional. The type of this key, which determines how it should be used on stream create requests.

optional .google.ads.admanager.v1.DaiAuthenticationKeyTypeEnum.DaiAuthenticationKeyType key_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the keyType field is set.

hasStatus()

public boolean hasStatus()

Output only. The status of this DaiAuthenticationKey.

DAI authentication keys are created in the ACTIVE state.

Only active keys will be accepted by the IMA SDK API as valid.

optional .google.ads.admanager.v1.DaiAuthenticationKeyStatusEnum.DaiAuthenticationKeyStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the status field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DaiAuthenticationKey.Builder newBuilderForType()
Returns
Type Description
DaiAuthenticationKey.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DaiAuthenticationKey.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DaiAuthenticationKey.Builder
Overrides

toBuilder()

public DaiAuthenticationKey.Builder toBuilder()
Returns
Type Description
DaiAuthenticationKey.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException