Class DaiAuthenticationKey.Builder (0.58.0)

public static final class DaiAuthenticationKey.Builder extends GeneratedMessage.Builder<DaiAuthenticationKey.Builder> implements DaiAuthenticationKeyOrBuilder

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

Protobuf type google.ads.admanager.v1.DaiAuthenticationKey

Static Methods

getDescriptor()

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

Methods

build()

public DaiAuthenticationKey build()
Returns
Type Description
DaiAuthenticationKey

buildPartial()

public DaiAuthenticationKey buildPartial()
Returns
Type Description
DaiAuthenticationKey

clear()

public DaiAuthenticationKey.Builder clear()
Returns
Type Description
DaiAuthenticationKey.Builder
Overrides

clearDisplayName()

public DaiAuthenticationKey.Builder clearDisplayName()

Required. The name for this DaiAuthenticationKey.

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

Returns
Type Description
DaiAuthenticationKey.Builder

This builder for chaining.

clearKeyType()

public DaiAuthenticationKey.Builder clearKeyType()

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
DaiAuthenticationKey.Builder

This builder for chaining.

clearName()

public DaiAuthenticationKey.Builder clearName()

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
DaiAuthenticationKey.Builder

This builder for chaining.

clearStatus()

public DaiAuthenticationKey.Builder clearStatus()

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
DaiAuthenticationKey.Builder

This builder for chaining.

getDefaultInstanceForType()

public DaiAuthenticationKey getDefaultInstanceForType()
Returns
Type Description
DaiAuthenticationKey

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DaiAuthenticationKey other)

public DaiAuthenticationKey.Builder mergeFrom(DaiAuthenticationKey other)
Parameter
Name Description
other DaiAuthenticationKey
Returns
Type Description
DaiAuthenticationKey.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DaiAuthenticationKey.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiAuthenticationKey.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DaiAuthenticationKey.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DaiAuthenticationKey.Builder
Overrides

setDisplayName(String value)

public DaiAuthenticationKey.Builder setDisplayName(String value)

Required. The name for this DaiAuthenticationKey.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
DaiAuthenticationKey.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DaiAuthenticationKey.Builder setDisplayNameBytes(ByteString value)

Required. The name for this DaiAuthenticationKey.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
DaiAuthenticationKey.Builder

This builder for chaining.

setKeyType(DaiAuthenticationKeyTypeEnum.DaiAuthenticationKeyType value)

public DaiAuthenticationKey.Builder setKeyType(DaiAuthenticationKeyTypeEnum.DaiAuthenticationKeyType value)

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];

Parameter
Name Description
value DaiAuthenticationKeyTypeEnum.DaiAuthenticationKeyType

The keyType to set.

Returns
Type Description
DaiAuthenticationKey.Builder

This builder for chaining.

setKeyTypeValue(int value)

public DaiAuthenticationKey.Builder setKeyTypeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for keyType to set.

Returns
Type Description
DaiAuthenticationKey.Builder

This builder for chaining.

setName(String value)

public DaiAuthenticationKey.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DaiAuthenticationKey.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DaiAuthenticationKey.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DaiAuthenticationKey.Builder

This builder for chaining.

setStatus(DaiAuthenticationKeyStatusEnum.DaiAuthenticationKeyStatus value)

public DaiAuthenticationKey.Builder setStatus(DaiAuthenticationKeyStatusEnum.DaiAuthenticationKeyStatus value)

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];

Parameter
Name Description
value DaiAuthenticationKeyStatusEnum.DaiAuthenticationKeyStatus

The status to set.

Returns
Type Description
DaiAuthenticationKey.Builder

This builder for chaining.

setStatusValue(int value)

public DaiAuthenticationKey.Builder setStatusValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for status to set.

Returns
Type Description
DaiAuthenticationKey.Builder

This builder for chaining.