Class CdnSecurityPolicy (0.54.0)

public final class CdnSecurityPolicy extends GeneratedMessage 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

Static Fields

KEYSET_FIELD_NUMBER

public static final int KEYSET_FIELD_NUMBER
Field Value
Type Description
int

MEDIA_PLAYLIST_ORIGIN_FORWARDING_TYPE_FIELD_NUMBER

public static final int MEDIA_PLAYLIST_ORIGIN_FORWARDING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

MEDIA_PLAYLIST_ORIGIN_PATH_PREFIX_FIELD_NUMBER

public static final int MEDIA_PLAYLIST_ORIGIN_PATH_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

ORIGIN_FORWARDING_TYPE_FIELD_NUMBER

public static final int ORIGIN_FORWARDING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

ORIGIN_PATH_PREFIX_FIELD_NUMBER

public static final int ORIGIN_PATH_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

SECURITY_POLICY_TYPE_FIELD_NUMBER

public static final int SECURITY_POLICY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SERVER_SIDE_URL_SIGNING_DISABLED_FIELD_NUMBER

public static final int SERVER_SIDE_URL_SIGNING_DISABLED_FIELD_NUMBER
Field Value
Type Description
int

SIGNED_REQUEST_EXPIRATION_TTL_FIELD_NUMBER

public static final int SIGNED_REQUEST_EXPIRATION_TTL_FIELD_NUMBER
Field Value
Type Description
int

TOKEN_AUTHENTICATION_KEY_FIELD_NUMBER

public static final int TOKEN_AUTHENTICATION_KEY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CdnSecurityPolicy getDefaultInstance()
Returns
Type Description
CdnSecurityPolicy

getDescriptor()

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

newBuilder()

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

newBuilder(CdnSecurityPolicy prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CdnSecurityPolicy getDefaultInstanceForType()
Returns
Type Description
CdnSecurityPolicy

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.

getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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 CdnSecurityPolicy.Builder newBuilderForType()
Returns
Type Description
CdnSecurityPolicy.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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