Class CdnSecurityPolicy.Builder (0.54.0)

0.54.0 (latest) 0.53.0 0.52.0 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class CdnSecurityPolicy.Builder extends GeneratedMessage.Builder<CdnSecurityPolicy.Builder> implements CdnSecurityPolicyOrBuilder

A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.

Protobuf type google.ads.admanager.v1.CdnSecurityPolicy

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > CdnSecurityPolicy.Builder

Implements

CdnSecurityPolicyOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public CdnSecurityPolicy build()

Returns
Type	Description
CdnSecurityPolicy

buildPartial()

public CdnSecurityPolicy buildPartial()

Returns
Type	Description
CdnSecurityPolicy

clear()

public CdnSecurityPolicy.Builder clear()

Returns
Type	Description
CdnSecurityPolicy.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearKeyset()

public CdnSecurityPolicy.Builder clearKeyset()

Optional. The name of the EdgeCacheKeyset on the Media CDN config that will be used to validate signed requests from DAI to ingest content.

optional string keyset = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

clearMediaPlaylistOriginForwardingType()

public CdnSecurityPolicy.Builder clearMediaPlaylistOriginForwardingType()

Optional. The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the CdnSecurityPolicyType set to CdnSecurityPolicyType.AKAMAI. Valid options are CdnSecurityPolicyOriginForwarding.NONE or CdnSecurityPolicyOriginForwarding.ORIGIN_PATH. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding media_playlist_origin_forwarding_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

clearMediaPlaylistOriginPathPrefix()

public CdnSecurityPolicy.Builder clearMediaPlaylistOriginPathPrefix()

Optional. The origin path prefix provided by the publisher for the media playlists. Only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string media_playlist_origin_path_prefix = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

clearOriginForwardingType()

public CdnSecurityPolicy.Builder clearOriginForwardingType()

Optional. The type of origin forwarding used to support Akamai authentication policies for the parent playlist. Not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to CdnSecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding origin_forwarding_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

clearOriginPathPrefix()

public CdnSecurityPolicy.Builder clearOriginPathPrefix()

Optional. The origin path prefix provided by the publisher for the parent playlist. Only applicable for delivery media locations with the value of originForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string origin_path_prefix = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

clearSecurityPolicyType()

public CdnSecurityPolicy.Builder clearSecurityPolicyType()

Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

optional .google.ads.admanager.v1.CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType security_policy_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

clearServerSideUrlSigningDisabled()

public CdnSecurityPolicy.Builder clearServerSideUrlSigningDisabled()

Optional. Whether the segment URLs should be signed using the

tokenAuthenticationKey on the server. This is only applicable for delivery

media locations that have token authentication enabled.

optional bool server_side_url_signing_disabled = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

clearSignedRequestExpirationTtl()

public CdnSecurityPolicy.Builder clearSignedRequestExpirationTtl()

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

optional .google.protobuf.Duration signed_request_expiration_ttl = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicy.Builder

clearTokenAuthenticationKey()

public CdnSecurityPolicy.Builder clearTokenAuthenticationKey()

Optional. Shared security key used to generate the Akamai HMAC token for authenticating requests. Only applicable when the value of CdnSecurityPolicyType is equal to CdnSecurityPolicyType.AKAMAI and will be set to null otherwise. Required when the CdnConfig.cdnConfigType is equal to CdnConfigType.LIVE_STREAM_SOURCE_CONTENT and this CdnSecurityPolicy is being configured for SourceContentConfig.ingestSettings.

optional string token_authentication_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

getDefaultInstanceForType()

public CdnSecurityPolicy getDefaultInstanceForType()

Returns
Type	Description
CdnSecurityPolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getKeyset()

public String getKeyset()

Optional. The name of the EdgeCacheKeyset on the Media CDN config that will be used to validate signed requests from DAI to ingest content.

optional string keyset = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The keyset.

getKeysetBytes()

public ByteString getKeysetBytes()

Optional. The name of the EdgeCacheKeyset on the Media CDN config that will be used to validate signed requests from DAI to ingest content.

optional string keyset = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for keyset.

getMediaPlaylistOriginForwardingType()

public CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding getMediaPlaylistOriginForwardingType()

Optional. The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the CdnSecurityPolicyType set to CdnSecurityPolicyType.AKAMAI. Valid options are CdnSecurityPolicyOriginForwarding.NONE or CdnSecurityPolicyOriginForwarding.ORIGIN_PATH. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding media_playlist_origin_forwarding_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding	The mediaPlaylistOriginForwardingType.

getMediaPlaylistOriginForwardingTypeValue()

public int getMediaPlaylistOriginForwardingTypeValue()

Optional. The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the CdnSecurityPolicyType set to CdnSecurityPolicyType.AKAMAI. Valid options are CdnSecurityPolicyOriginForwarding.NONE or CdnSecurityPolicyOriginForwarding.ORIGIN_PATH. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding media_playlist_origin_forwarding_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for mediaPlaylistOriginForwardingType.

getMediaPlaylistOriginPathPrefix()

public String getMediaPlaylistOriginPathPrefix()

Optional. The origin path prefix provided by the publisher for the media playlists. Only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string media_playlist_origin_path_prefix = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The mediaPlaylistOriginPathPrefix.

getMediaPlaylistOriginPathPrefixBytes()

public ByteString getMediaPlaylistOriginPathPrefixBytes()

Optional. The origin path prefix provided by the publisher for the media playlists. Only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string media_playlist_origin_path_prefix = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for mediaPlaylistOriginPathPrefix.

getOriginForwardingType()

public CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding getOriginForwardingType()

Optional. The type of origin forwarding used to support Akamai authentication policies for the parent playlist. Not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to CdnSecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding origin_forwarding_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding	The originForwardingType.

getOriginForwardingTypeValue()

public int getOriginForwardingTypeValue()

Optional. The type of origin forwarding used to support Akamai authentication policies for the parent playlist. Not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to CdnSecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding origin_forwarding_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for originForwardingType.

getOriginPathPrefix()

public String getOriginPathPrefix()

Optional. The origin path prefix provided by the publisher for the parent playlist. Only applicable for delivery media locations with the value of originForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string origin_path_prefix = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The originPathPrefix.

getOriginPathPrefixBytes()

public ByteString getOriginPathPrefixBytes()

Optional. The origin path prefix provided by the publisher for the parent playlist. Only applicable for delivery media locations with the value of originForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string origin_path_prefix = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for originPathPrefix.

getSecurityPolicyType()

public CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType getSecurityPolicyType()

Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

optional .google.ads.admanager.v1.CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType security_policy_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType	The securityPolicyType.

getSecurityPolicyTypeValue()

public int getSecurityPolicyTypeValue()

Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

optional .google.ads.admanager.v1.CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType security_policy_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for securityPolicyType.

getServerSideUrlSigningDisabled()

public boolean getServerSideUrlSigningDisabled()

Optional. Whether the segment URLs should be signed using the

tokenAuthenticationKey on the server. This is only applicable for delivery

media locations that have token authentication enabled.

optional bool server_side_url_signing_disabled = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The serverSideUrlSigningDisabled.

getSignedRequestExpirationTtl()

public Duration getSignedRequestExpirationTtl()

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

optional .google.protobuf.Duration signed_request_expiration_ttl = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Duration	The signedRequestExpirationTtl.

getSignedRequestExpirationTtlBuilder()

public Duration.Builder getSignedRequestExpirationTtlBuilder()

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

optional .google.protobuf.Duration signed_request_expiration_ttl = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Builder

getSignedRequestExpirationTtlOrBuilder()

public DurationOrBuilder getSignedRequestExpirationTtlOrBuilder()

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

optional .google.protobuf.Duration signed_request_expiration_ttl = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DurationOrBuilder

getTokenAuthenticationKey()

public String getTokenAuthenticationKey()

Optional. Shared security key used to generate the Akamai HMAC token for authenticating requests. Only applicable when the value of CdnSecurityPolicyType is equal to CdnSecurityPolicyType.AKAMAI and will be set to null otherwise. Required when the CdnConfig.cdnConfigType is equal to CdnConfigType.LIVE_STREAM_SOURCE_CONTENT and this CdnSecurityPolicy is being configured for SourceContentConfig.ingestSettings.

optional string token_authentication_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The tokenAuthenticationKey.

getTokenAuthenticationKeyBytes()

public ByteString getTokenAuthenticationKeyBytes()

Optional. Shared security key used to generate the Akamai HMAC token for authenticating requests. Only applicable when the value of CdnSecurityPolicyType is equal to CdnSecurityPolicyType.AKAMAI and will be set to null otherwise. Required when the CdnConfig.cdnConfigType is equal to CdnConfigType.LIVE_STREAM_SOURCE_CONTENT and this CdnSecurityPolicy is being configured for SourceContentConfig.ingestSettings.

optional string token_authentication_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for tokenAuthenticationKey.

hasKeyset()

public boolean hasKeyset()

Optional. The name of the EdgeCacheKeyset on the Media CDN config that will be used to validate signed requests from DAI to ingest content.

optional string keyset = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the keyset field is set.

hasMediaPlaylistOriginForwardingType()

public boolean hasMediaPlaylistOriginForwardingType()

Optional. The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the CdnSecurityPolicyType set to CdnSecurityPolicyType.AKAMAI. Valid options are CdnSecurityPolicyOriginForwarding.NONE or CdnSecurityPolicyOriginForwarding.ORIGIN_PATH. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding media_playlist_origin_forwarding_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the mediaPlaylistOriginForwardingType field is set.

hasMediaPlaylistOriginPathPrefix()

public boolean hasMediaPlaylistOriginPathPrefix()

Optional. The origin path prefix provided by the publisher for the media playlists. Only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string media_playlist_origin_path_prefix = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the mediaPlaylistOriginPathPrefix field is set.

hasOriginForwardingType()

public boolean hasOriginForwardingType()

Optional. The type of origin forwarding used to support Akamai authentication policies for the parent playlist. Not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to CdnSecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding origin_forwarding_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the originForwardingType field is set.

hasOriginPathPrefix()

public boolean hasOriginPathPrefix()

Optional. The origin path prefix provided by the publisher for the parent playlist. Only applicable for delivery media locations with the value of originForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string origin_path_prefix = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the originPathPrefix field is set.

hasSecurityPolicyType()

public boolean hasSecurityPolicyType()

Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

optional .google.ads.admanager.v1.CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType security_policy_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the securityPolicyType field is set.

hasServerSideUrlSigningDisabled()

public boolean hasServerSideUrlSigningDisabled()

Optional. Whether the segment URLs should be signed using the

tokenAuthenticationKey on the server. This is only applicable for delivery

media locations that have token authentication enabled.

optional bool server_side_url_signing_disabled = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the serverSideUrlSigningDisabled field is set.

hasSignedRequestExpirationTtl()

public boolean hasSignedRequestExpirationTtl()

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

optional .google.protobuf.Duration signed_request_expiration_ttl = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the signedRequestExpirationTtl field is set.

hasTokenAuthenticationKey()

public boolean hasTokenAuthenticationKey()

Optional. Shared security key used to generate the Akamai HMAC token for authenticating requests. Only applicable when the value of CdnSecurityPolicyType is equal to CdnSecurityPolicyType.AKAMAI and will be set to null otherwise. Required when the CdnConfig.cdnConfigType is equal to CdnConfigType.LIVE_STREAM_SOURCE_CONTENT and this CdnSecurityPolicy is being configured for SourceContentConfig.ingestSettings.

optional string token_authentication_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the tokenAuthenticationKey field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(CdnSecurityPolicy other)

public CdnSecurityPolicy.Builder mergeFrom(CdnSecurityPolicy other)

Parameter
Name	Description
other	CdnSecurityPolicy

Returns
Type	Description
CdnSecurityPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CdnSecurityPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CdnSecurityPolicy.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CdnSecurityPolicy.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CdnSecurityPolicy.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSignedRequestExpirationTtl(Duration value)

public CdnSecurityPolicy.Builder mergeSignedRequestExpirationTtl(Duration value)

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

optional .google.protobuf.Duration signed_request_expiration_ttl = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Duration

Returns
Type	Description
CdnSecurityPolicy.Builder

setKeyset(String value)

public CdnSecurityPolicy.Builder setKeyset(String value)

Optional. The name of the EdgeCacheKeyset on the Media CDN config that will be used to validate signed requests from DAI to ingest content.

optional string keyset = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The keyset to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setKeysetBytes(ByteString value)

public CdnSecurityPolicy.Builder setKeysetBytes(ByteString value)

Optional. The name of the EdgeCacheKeyset on the Media CDN config that will be used to validate signed requests from DAI to ingest content.

optional string keyset = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for keyset to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setMediaPlaylistOriginForwardingType(CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding value)

public CdnSecurityPolicy.Builder setMediaPlaylistOriginForwardingType(CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding value)

Optional. The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the CdnSecurityPolicyType set to CdnSecurityPolicyType.AKAMAI. Valid options are CdnSecurityPolicyOriginForwarding.NONE or CdnSecurityPolicyOriginForwarding.ORIGIN_PATH. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding media_playlist_origin_forwarding_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding The mediaPlaylistOriginForwardingType to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setMediaPlaylistOriginForwardingTypeValue(int value)

public CdnSecurityPolicy.Builder setMediaPlaylistOriginForwardingTypeValue(int value)

Optional. The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the CdnSecurityPolicyType set to CdnSecurityPolicyType.AKAMAI. Valid options are CdnSecurityPolicyOriginForwarding.NONE or CdnSecurityPolicyOriginForwarding.ORIGIN_PATH. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding media_playlist_origin_forwarding_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for mediaPlaylistOriginForwardingType to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setMediaPlaylistOriginPathPrefix(String value)

public CdnSecurityPolicy.Builder setMediaPlaylistOriginPathPrefix(String value)

Optional. The origin path prefix provided by the publisher for the media playlists. Only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string media_playlist_origin_path_prefix = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The mediaPlaylistOriginPathPrefix to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setMediaPlaylistOriginPathPrefixBytes(ByteString value)

public CdnSecurityPolicy.Builder setMediaPlaylistOriginPathPrefixBytes(ByteString value)

Optional. The origin path prefix provided by the publisher for the media playlists. Only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string media_playlist_origin_path_prefix = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for mediaPlaylistOriginPathPrefix to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setOriginForwardingType(CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding value)

public CdnSecurityPolicy.Builder setOriginForwardingType(CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding value)

Optional. The type of origin forwarding used to support Akamai authentication policies for the parent playlist. Not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to CdnSecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding origin_forwarding_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding The originForwardingType to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setOriginForwardingTypeValue(int value)

public CdnSecurityPolicy.Builder setOriginForwardingTypeValue(int value)

Optional. The type of origin forwarding used to support Akamai authentication policies for the parent playlist. Not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to CdnSecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

optional .google.ads.admanager.v1.CdnSecurityPolicyOriginForwardingEnum.CdnSecurityPolicyOriginForwarding origin_forwarding_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for originForwardingType to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setOriginPathPrefix(String value)

public CdnSecurityPolicy.Builder setOriginPathPrefix(String value)

Optional. The origin path prefix provided by the publisher for the parent playlist. Only applicable for delivery media locations with the value of originForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string origin_path_prefix = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The originPathPrefix to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setOriginPathPrefixBytes(ByteString value)

public CdnSecurityPolicy.Builder setOriginPathPrefixBytes(ByteString value)

Optional. The origin path prefix provided by the publisher for the parent playlist. Only applicable for delivery media locations with the value of originForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.

optional string origin_path_prefix = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for originPathPrefix to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setSecurityPolicyType(CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType value)

public CdnSecurityPolicy.Builder setSecurityPolicyType(CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType value)

Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

optional .google.ads.admanager.v1.CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType security_policy_type = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType The securityPolicyType to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setSecurityPolicyTypeValue(int value)

public CdnSecurityPolicy.Builder setSecurityPolicyTypeValue(int value)

Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.

optional .google.ads.admanager.v1.CdnSecurityPolicyTypeEnum.CdnSecurityPolicyType security_policy_type = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	int The enum numeric value on the wire for securityPolicyType to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setServerSideUrlSigningDisabled(boolean value)

public CdnSecurityPolicy.Builder setServerSideUrlSigningDisabled(boolean value)

Optional. Whether the segment URLs should be signed using the

tokenAuthenticationKey on the server. This is only applicable for delivery

media locations that have token authentication enabled.

optional bool server_side_url_signing_disabled = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The serverSideUrlSigningDisabled to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setSignedRequestExpirationTtl(Duration value)

public CdnSecurityPolicy.Builder setSignedRequestExpirationTtl(Duration value)

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

optional .google.protobuf.Duration signed_request_expiration_ttl = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Duration

Returns
Type	Description
CdnSecurityPolicy.Builder

setSignedRequestExpirationTtl(Duration.Builder builderForValue)

public CdnSecurityPolicy.Builder setSignedRequestExpirationTtl(Duration.Builder builderForValue)

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

optional .google.protobuf.Duration signed_request_expiration_ttl = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
CdnSecurityPolicy.Builder

setTokenAuthenticationKey(String value)

public CdnSecurityPolicy.Builder setTokenAuthenticationKey(String value)

Optional. Shared security key used to generate the Akamai HMAC token for authenticating requests. Only applicable when the value of CdnSecurityPolicyType is equal to CdnSecurityPolicyType.AKAMAI and will be set to null otherwise. Required when the CdnConfig.cdnConfigType is equal to CdnConfigType.LIVE_STREAM_SOURCE_CONTENT and this CdnSecurityPolicy is being configured for SourceContentConfig.ingestSettings.

optional string token_authentication_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The tokenAuthenticationKey to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.

setTokenAuthenticationKeyBytes(ByteString value)

public CdnSecurityPolicy.Builder setTokenAuthenticationKeyBytes(ByteString value)

Optional. Shared security key used to generate the Akamai HMAC token for authenticating requests. Only applicable when the value of CdnSecurityPolicyType is equal to CdnSecurityPolicyType.AKAMAI and will be set to null otherwise. Required when the CdnConfig.cdnConfigType is equal to CdnConfigType.LIVE_STREAM_SOURCE_CONTENT and this CdnSecurityPolicy is being configured for SourceContentConfig.ingestSettings.

optional string token_authentication_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for tokenAuthenticationKey to set.

Returns
Type	Description
CdnSecurityPolicy.Builder	This builder for chaining.